Sending Customer Settlement Transaction Requests

Customer settlement transactions are created upon requests from a customer information system (CIS). Customer settlement transaction requests are sent in a file which is processed by a batch process which creates the individual customer settlement transactions. Customer settlement transaction requests include the customer contact or account or metered service, the program, the start and end date for the requested time period, and the type of request.

See About Customer Settlement Transactions for more information.

Uploading Customer Settlement Transaction Requests

Customer settlement requests are uploaded using the Customer Settlement Transaction Upload (X1-CSTUP) batch process. This batch process uploads data from a .tab-delimited file. For each data row in the file, this process creates a Customer Settlement Transaction record.

This batch processes use the following parameters:

  • File Name: The name of the file to upload. File names can use wildcards (Required)

  • Flat Path: The file location where the upload file is located. This can be a file location on a local server or a location in Object Storage. See Referencing URIs in the Framework Administrative User Guide for more information. (Required)

  • Processed File Extension: The text appended to the file name after the file has been processed. Default is "PROCESSED".

  • Error On No Files Found: Indicates whether or not an error is issued if no files are found matching the given name in the given path. Valid values are "true" (default) and "false".

Use the Batch Control portal to learn more about these and other parameters used by these batch process.

Customer Settlement Request Upload File Format

Customer settlement request upload files use the following tab-separated values format:

Field Name

Optional/Required

Notes

External Settlement Request ID

Required

An id for the customer settlement request from the CIS application.

External Contact ID*

Required*

The external id of the customer for which the Customer Settlement will be created. For requests from Customer Care and Billing or Customer to Meter, this is the Person ID.

External Account ID*

Required*

The external id of the account for which the Customer Settlement will be created. For requests from Customer Care and Billing or Customer to Meter, this is the Account ID.

External Metered Service ID*

Required*

The external id of the metered service for which the Customer Settlement will be created.

For requests from Customer Care and Billing or Customer to Meter, this is the Service Agreement ID.

External Program ID

Required

The external ID of the program for which the Customer Settlement will be created.

This is used for filtering in case the customer is enrolled in multiple programs.

Start Date

Required

The date on which the customer settlement period starts. This assumes a start time at the start of the day.

End Date

Required

The date on which the customer settlement period ends. This assumes a start time at the end of the day.

Customer Settlement Request Type

Required

A flag that indicates the type of customer settlement request. Valid values are values for the Event Settlement Request Type (EVT_​SETT_​REQ_​TYPE_​FLG) lookup, and include:

  • D1FL (Final)

  • D1PC (Periodic)

  • D1RL (Rebill)

  • D1UT (Unenrollment)

* Only 1 of the fields markers with an asterisk (*) can be included:

  • If the External Contact ID is provided, the system evaluates all Metered Services for the contact.
  • If the External Account ID is provided, the system evaluates all Metered Services for the account.
  • If the External Metered Service ID is defined as a Settlement Group on a Program Subscription, the Customer Settlement is run with the Settlement Aggregation Method set to "Grouped". See About Customer Settlement Transactionsfor more information.

Sample Record

Below is a sample file:

Tmp5    MBFEXT0605_1    PRG002    2023-04-06    2023-04-07    D1FL