Implementation Guide for Oracle Self-Service E-Billing > Customizing the Payment Consolidator Integration Module > Default File Formats for Payment Consolidation >

Bill Summary Output File Format


This topic describes the default format of the bill summary output file that Oracle Self-Service E-Billing is preconfigured to create.

Table 113 shows the header data elements data elements in the default format of the bill summary output file.

Table 113. File Header Data Elements for the Bill Summary Output File
Data Element
Length
Type
Required by the API
Description

Header Record Type

4

Num

No

A number indicating this is the header record type.

Sender ID

32

Varchar

Yes

The unique ID for the entity sending the request.

Receiver ID

32

Varchar

Yes

The unique ID for the entity receiving the request.

Sender Name

32

Varchar

Yes

The name of the entity sending the request.

File ID

32

Varchar

Yes

The file identifier.

File Creation Date

8

Date

Yes

The file creation date, in YYYYMMDD format.

File Creation Time

12

Time

Yes

The file creation time, in HHMMSSmmmmmm format.

Time Zone Offset

3

Varchar

No

The time zone offset, such as +03, -05, and so forth.

Custom Field 1

32

Varchar

No

For future use.

Custom Field 2

32

Varchar

No

For future use.

End of Record

2

None

Yes for some consolidators

For some consolidators, this field must contain the hexadecimal value 0D0A.

Table 114 shows the data elements in the batch header record for the Bill Summary file.

Table 114. Batch Header Data Elements for the Bill Summary Output File
Data Element
Length
Type
Required by the API
Description

Batch Record Type

4

Num

No

Part of the batch header.

Biller ID

32

Varchar

No

Part of the batch header.

Biller Name

32

Varchar

No

Part of the batch header.

Batch ID

7

Num

No

Part of the batch header.

Custom Field 1

32

Varchar

No

Part of the batch header.

Custom Field 2

32

Varchar

No

Part of the batch header.

Table 115 shows the body detail data elements in the default format of the bill summary output file.

Table 115. Body Detail Data Elements for the Bill Summary Output File
Data Element
Length
Type
Required by the API
Description

Detail Record Type

4

Num

No

A number indicating this is the detail record type.

Action Type

10

Varchar

No

The type of action, for example:

  • ADD. When the consolidator sends a record to activate bill payment service.
  • CHG. If the biller later sends a change regarding the service holder's current information, such as a change to the service address.

Consolidator ID

32

Varchar

Yes

The ID of the consolidator, available in the Consolidator User Enrollment table.

Bill Processing Center Number

9

Varchar

No

The ID of the bill processing center that processes bills for this account, available in the Consolidator User Enrollment table.

Biller ID

32

Varchar

Yes

A unique ID for the biller, implementation-specific, available in the Consolidator User Enrollment table.

Billing System ID

32

Varchar

No

The ID of the billing system used in combination with account number to uniquely identify an account.

Biller Account Number

32

Varchar

Yes

The user account number.

Alternate Biller Account Number

32

Varchar

Yes

The internal biller account number, available in the Consolidator User Enrollment table.

Biller Transaction ID

32

Varchar

No

The biller transaction ID, sent in the enrollment input file.

Biller User ID

32

Varchar

No

The biller user ID, sent in the enrollment input file.

Biller E-Bill ID

36

Varchar

Yes

The unique ID for the bill, assigned by the biller. It is usually the invoice number on the bill. Otherwise, it is populated with amount due and bill due date.

User First Name

32

Varchar

No

The user's first name.

User Last Name

32

Varchar

No

The user's last name.

Payment Received

20

Numeric

Yes

The net payment received and credited to the account since the last period.

Amount Due

20

Numeric

Yes

The amount that must be displayed to the subscriber for payment. It can be the minimum amount due, this period's payment due, or the total account balance.

Balance Amount

20

Numeric

No

The account balance at the time of the closing cycle date.

Minimum Amount Due

20

Numeric

No

The minimum amount due.

Previous Balance Amount

20

Numeric

No

The previous balance amount.

Biller Reference Text

20

Varchar

No

Text the biller sends with the electronic bill. Invoice-like information to be sent with particular bills that must be returned to the biller for posting purposes.

Statement Date

20

Datetime

Yes

The timestamp when bill was created, in YYYYMMDDHHMMSSmmmmmm format.

Next Statement Date

20

Datetime

No

The timestamp when the bill was created, in YYYYMMDDHHMMSSmmmmmm format.

Bill Cycle End Date

20

Datetime

No

The timestamp when the bill period was closed.

Payment Due Text Flag

1

Char

No

A flag indicating to the consolidator whether the biller wants the sponsor to display Text Due Date instead of the Electronic Bill Due Date Timestamp. If the sponsor does not support Text Due Date, then it uses the Electronic Bill Due Date Timestamp.

Bill Due Date

20

Datetime

No

Timestamp when the bill is due.

Text Due Date

20

Datetime

No

When the Payment Due Text Flag value is Y, the values in this field are displayed to the user, spaces included.

Bill Cycle Start Date

20

Datetime

No

Timestamp when this bill was opened.

Electronic Billing URL

1024

Varchar

No

The URL for viewing bill details in Oracle Self-Service E-Billing.

Bill URL Expiry Date

20

Datetime

No

The time when the URL expires.

Teaser Link URL

1024

Varchar

No

The URL for the teaser ad that the subscriber can follow to receive additional information from the biller.

This URL is used in conjunction with either the Teaser Ad URL or the Teaser Ad Text. The subscriber can click on either the image or text to be transferred to the biller site specified by this URL.

Teaser Ad URL

1024

Varchar

No

The URL where the teaser ad image is stored. This is used to display the image on the user interface.

Teaser Ad Text

80

Varchar

No

A text link that can be used instead of the image link. Using this text might improve performance over downloading a teaser ad image.

E-Bill Category URL

1024

Varchar

No

The URL associated with the ebill's category.

E-Bill Category Text

80

Varchar

No

The text associated with the ebill's category.

E-Bill Magnet Type

1

Char

No

Determines whether a customer magnet is required for this electronic bill. The values can be:

  • M. Magnet has its own URL.
  • Y. Magnet uses the Electronic Bill URL. (The Magnet URL must be spaces).
  • N. No, a customer magnet is not required (The Magnet URL must be spaces). This is the default.

NOTE:  The customer magnet feature is not supported by many sponsors. The feature is being deprecated.

E-Bill Magnet URL

1024

Varchar

No

The URL (teaser ad or promotional offer) to where a subscriber is taken before making a payment.

E-Bill Category

2

Varchar

No

The e-bill category. Values can be spaces for a normal e-bill (the default), or 02 for an e-bill supplied by a biller to replace a previous ebill.

Status Code

5

Varchar

No

The status code.

Status Message

80

Varchar

No

The status message.

Custom Field 1

255

Varchar

No

For future use.

Custom Field 2

255

Varchar

No

For future use.

Custom Field 3

255

Varchar

No

For future use.

Custom Field 4

255

Varchar

No

For future use.

Custom Field 5

1024

Varchar

No

For future use.

Custom Field 6

1

Char

No

For future use.

Custom Field 7

1

Char

No

For future use.

Custom Field 8

20

String

No

For future use.

Custom Field 9

20

String

No

For future use.

End of Record

2

None

No

For some consolidators, this field must contain the hexadecimal value 0D0A.

Table 116 shows the batch control data elements in the default format of the bill summary output file.

Table 116. Batch Control Data Elements for the Bill Summary Output File
Data Element
Length
Type
Required by the API
Description

Batch Control Record Type Code

4

Varchar

No

The batch control record type code.

Total Record Count

8

Num

No

The total number of records.

Batch ID

7

Num

No

The ID identifying the batch.

Table 117 shows the file control (trailer) data elements in the default format of the bill summary output file.

Table 117. File Control Data Elements for the Bill Summary Output File
Data Element
Length
Type
Required by the API
Description

Trailer Record Type

4

Num

No

The value must be 9999 for some consolidators.

Record Type 1

4

Varchar

No

Record Type 1

Number of Records 1

6

Num

No

Number of Records 1

Record Type 2

4

Varchar

No

Record Type 2

Number of Records 2

6

Num

No

Number of Records 2

Record Type 3

4

Varchar

No

Record Type 3

Number of Records 3

6

Num

No

Number of Records 3

Record Type 4

4

Varchar

No

Record Type 4

Number of Records 4

6

Num

No

Number of Records 4

Record Type 5

4

Varchar

No

Record Type 5

Number of Records 5

6

Num

No

Number of Records 5

Record Type 6

4

Varchar

No

Record Type 6

Number of Records 6

6

Num

No

Number of Records 6

Record Type 7

4

Varchar

No

Record Type 7

Number of Records 7

6

Num

No

Number of Records 7

Record Type 8

4

Varchar

No

Record Type 8

Number of Records 8

6

Num

No

Number of Records 8

Record Type 9

4

Varchar

No

Record Type

Number of Records 9

6

Num

No

Number of Records 9

Record Type 10

4

Varchar

No

Record Type 10

Number of Records 10

6

Num

No

Number of Records 10

Record Type 11

4

Varchar

No

Record Type 11

Number of Records 11

6

Num

No

Number of Records 11

Record Type 12

4

Varchar

No

Record Type 12

Number of Records 12

6

Num

No

Number of Records 12

Record Type 13

4

Varchar

No

Record Type 13

Number of Records 13

6

Num

No

Number of Records 13

Record Type 14

4

Varchar

No

Record Type 14

Number of Records 14

6

Num

No

Number of Records 14

Record Type 15

4

Varchar

No

Record Type 15

Number of Records 15

6

Num

No

Number of Records 15

Record Type 16

4

Varchar

No

Record Type 16

Number of Records 16

6

Num

No

Number of Records 16

Record Type 17

4

Varchar

No

Record Type 17

Number of Records 17

6

Num

No

Number of Records 17

Custom Field 1

85

Varchar

No

Custom field 1

Total Batch Count

6

Varchar

No

Total batch count.

Total Record Count

8

Num

No

Total number of records.

File ID

32

Num

No

The file identifier.

End of Record

2

Varchar

No

For some consolidators, this field must contain the hexadecimal value 0D0A.

Implementation Guide for Oracle Self-Service E-Billing Copyright © 2014, Oracle and/or its affiliates. All rights reserved. Legal Notices.