Bill Segment Fields

A bill typically contains one bill segment for every active service agreement linked to its account. A bill segment is a portion of a bill that corresponds to one or more line items in a bill. Line items could be taxes, usage charges, and other fees.

It is expected that for consecutive bills, there will be no gaps between the bill_segment_end_date of the first bill segment and the bill_segment_start_date of the next bill's segment.

For example, if the first bill's segment had a bill_segment_end_date of 2019-01-01 00:00:00, then the next bill's corresponding segment would be expected to have a bill_segment_start_date of 2019-01-01 00:00:00 as well.

Field	Description
bill_id	The primary utility identifier of a bill. This is used to disambiguate bills. Type: VARCHAR(40) Can Be Empty?: No. Primary Key. Note: This field is not required if you are sending your billing data in a single file to Oracle Utilities. See Billing Data File Specifications for more information.
bill_segment_id	The unique identifier of the bill segment in the source system. Type: VARCHAR(40) Can Be Empty?: No. Primary Key. Note: This field is not required if you are sending your billing data in a single file to Oracle Utilities. See Billing Data File Specifications for more information.
service_agreement_id	The utility’s service agreement identifier. This field corresponds to a service agreement in the Oracle Utilities Customer Care and Billing data model. See Service Agreement Fields for more detail. Type: VARCHAR(40) Can Be Empty?: No.
bill_segment_start_datetime	The start of the period of time covered by the bill segment’s charges. The bill period is inclusive of this datetime value. Type: DATETIME. See Date and Time Handling for details. Can Be Empty?: No.
bill_segment_end_datetime	The end of the period of time covered by the bill segment’s charges. The bill period is exclusive of this datetime value. Type: DATETIME. See Date and Time Handling for details. Can Be Empty?: No.
usage_period_start_datetime	The start date used by Oracle Utilities Meter Data Management to determine the correct interval data to process for the bill segment. The usage period is inclusive of this datetime value. It is typically a day behind the `bill_segment_start_datetime` (but could also be the same or different by more days, depending on your particular setup). If you are not using Meter Data Management, this is not a required field. Type: DATETIME. See Date and Time Handling for details. Can Be Empty?: Yes.
usage_period_end_datetime	The end date used by Oracle Utilities Meter Data Management to determine the correct interval data to process for the bill segment. The usage period is exclusive of this datetime value. It is typically a day behind the `bill_segment_end_datetime` (but could also be the same or different by more days, depending on your particular setup). If you are not using Meter Data Management, this is not a required field. Type: DATETIME. See Date and Time Handling for details. Can Be Empty?: Yes.
estimated	A Boolean value to indicate whether or not this value was estimated. Type: BOOLEAN. See Supported Boolean Formats for more information. Can Be Empty?: Yes.
closing	A Boolean value to indicate whether this is the final bill segment for the service agreement (that is, the service agreement has been stopped and this is the final bill segment). Allowed Values: Y Value indicating the final bill segment. N (Default) Value indicating that this is not the final bill segment. Type: BOOLEAN. See Supported Boolean Formats for more information. Can Be Empty?: Yes.
bill_segment_status	The status of the bill segment. Your Delivery Team will work with you during the launch process to confirm the status values to use. Example Values: Incomplete Bill segments are initially created in the Incomplete state since they do not have bill lines. Freezable After successful generation of a bill segment, the status of the bill segment becomes Freezable. Frozen A bill segment may now appear on customer’s bill and cannot be changed. Pending Cancel A new financial transaction was generated to correct the bill segment. Canceled A new financial transaction was generated to correct the bill segment. Note: The `Incomplete`, `Freezable`, and `Pending Cancel` statuses are not expected to appear in Oracle Utilities DataConnect extracts. The DataConnect tool only extracts bills that are complete. Type: VARCHAR(20) Can Be Empty?: No.
bill_cycle_code	The bill cycle of the bill segment's bill. This information is only populated on bills when they are generated on-schedule by the batch billing background process. Example Values: M01,M02 Type: VARCHAR(20) Can Be Empty?: Yes, but preferred to not be empty.
bill_cycle_description	A description of the bill cycle. Example Values: Monthly bill cycle - day 1, Monthly bill cycle - day 2 Type: VARCHAR(255) Can Be Empty?: Yes.
current_amount	The aggregate amount owed on a service agreement for the bill period. Type: DECIMAL(15,2). See Supported Decimal Formats for details. Can Be Empty?: No.
outstanding_amount	The aggregate total outstanding amount for the service agreement. This is likely the same as the current amount unless there is a budget billing arrangement. Note that budget billing arrangements are made per Service Agreement, and then rolled up to the bill/account level. Type: DECIMAL(15,2). See Supported Decimal Formats for details. Can Be Empty?: No.
master_bill_segment_id	The identifier of the master service agreement’s bill segment. The `master_bill_segment_id` must reference another `bill_segment_id` that was previously sent, or is part of the same file that this bill segment was sent in. Type: VARCHAR(40) Can Be Empty?: Yes.
bill_segment_updated_at	The date at which the record was updated in the source system. If left blank, the field does not store any data. Type: DATETIME. See Date and Time Handling for details. Can Be Empty?: Yes.