Bill Segment Summary
get
/rest/apis/customer/financials/billSegments/{billSegmentId}/summary
Request
Path Parameters
-
billSegmentId(required): string
Bill Segment ID is the system-assigned unique identifier of the bill segment.Example:
211366855400
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/xml
- application/json
200 Response
Success response
Root Schema : C1BilSegSmry
Type:
Show Source
object
-
bill: object
bill
-
billSegment: object
billSegment
-
billSegmentInformation: string
Maximum Length:
254
Bill Segment Information is a concatenation of the bill segment's division, SA type, status, bill period and amount.Example:California / Electric residential, Frozen, Period: 03-01-2009 - 04-01-2009, $30.92, 9991959350
-
billSegmentStatus: string
Allowed Values:
[ "10 ", "20 ", "30 ", "40 ", "50 ", "60 ", "70 " ]
Bill Segment Status: * `10 ` - Incomplete, * `20 ` - Error, * `30 ` - Freezable, * `40 ` - Pending Cancel, * `50 ` - Frozen, * `60 ` - Canceled, * `70 ` - OK -
billSegmentStatusDescription: string
Maximum Length:
150
Description for bill segment's status.Example:Freezable
-
billStatus: string
Allowed Values:
[ "C ", "P " ]
Bill Status is the bill's status. * `C ` - Complete, * `P ` - PendingExample:C
-
calcLines: object
calcLines
-
cancelReason: string
Maximum Length:
4
Cancel Reason defines why the bill segment(s) are being canceled.Example:Wrong read
-
cancelReasonDescription: string
(canRsnDesc)
-
currency: object
currency
-
currentAmount: number
Current Amount is the bill segment's effect on the service agreement's current balance.Example:
$405.52
-
hasServiceQuantityOverride: boolean
SQ Override
-
isCancelled: boolean
The Cancel is used to cancel a Pending Cancel bill segment to become Canceled.Example:
true
-
isClosingBillSegment: boolean
If the Closing switch is on, this is the final bill segment for the service agreement (i.e., the service agreement has been stopped and this is the final bill segment).Example:
true
-
isEstimate: boolean
If the Estimate switch is on, consumption on this bill segment has been estimated by the system.Example:
true
-
isFrozen: boolean
The Freeze is used to freeze one or more bill segments.
-
isItemOverride: boolean
Item Override
-
periodEndDate: string
(date)
End Date
-
periodStartDate: string
(date)
Start Date
-
premise: object
premise
-
serviceAgreement: object
serviceAgreement
-
serviceAgreementType: object
serviceAgreementType
-
serviceType: object
serviceType
Service Type defines the type of service associated with the SA type.
-
totalQuantity: object
totalQuantity
Nested Schema : bill
Type:
Show Source
object
-
_link: string
_link
-
billId: string
Maximum Length:
12
Bill ID is the system-assigned unique identifier of the bill on which the bill segment appears. A concatenation of its bill date, status, due date and amount is displayed.Example:211122345678
Nested Schema : billSegment
Type:
Show Source
object
-
_link: string
_link
-
billSegmentId: string
Maximum Length:
12
Bill Segment ID is the system-assigned unique identifier of the bill segment.Example:211366855400
Nested Schema : currency
Type:
Show Source
object
-
_link: string
_link
-
currency: string
Maximum Length:
3
Currency Code
Nested Schema : premise
Type:
Show Source
object
-
_link: string
_link
-
premiseId: string
Maximum Length:
10
Premise ID defines the address on bills for persons who have their bill sent to the account's mailing premise. -
premiseInfo: string
Maximum Length:
254
Premise ID defines the address on bills for persons who have their bill sent to the account's mailing premise.
Nested Schema : serviceAgreement
Type:
Show Source
object
-
_link: string
_link
-
serviceAgreementId: string
Maximum Length:
10
SA ID contains information about the bill segment's service agreement.Example:0340281111
Nested Schema : serviceAgreementType
Type:
Show Source
object
-
_link: string
_link
-
division: string
Maximum Length:
1
The CIS division for service agreements is part of the service agreement's SA type. The SA type controls many business rules, and thus all business rules that are on the SA type are defined for a given jurisdiction and SA type combination.Example:OH
-
divisionDescription: string
Maximum Length:
1
The CIS division for service agreements is part of the service agreement's SA type. The SA type controls many business rules, and thus all business rules that are on the SA type are defined for a given jurisdiction and SA type combination.Example:OH
-
saType: string
Maximum Length:
8
The CIS division for service agreements is part of the service agreement's SA type. The SA type controls many business rules, and thus all business rules that are on the SA type are defined for a given jurisdiction and SA type combination.Example:OH
-
serviceAgreementTypeDescription: string
Maximum Length:
30
The CIS division for service agreements is part of the service agreement's SA type. The SA type controls many business rules, and thus all business rules that are on the SA type are defined for a given jurisdiction and SA type combination.Example:OH
Nested Schema : serviceType
Type:
object
Service Type defines the type of service associated with the SA type.
Show Source
-
_link: string
_link
-
serviceType: string
Maximum Length:
80
Service Type defines the type of service associated with the SA type.Example:E
Nested Schema : totalQuantity
Type:
Show Source
object
-
totalFoundIndicator: boolean
Total Found Indicator flag is true when SA's SA Type UOM matches UOM from the Bill Segment's Service Quantity collection.Example:
true
-
totalServiceQuantity: number
Minimum Value:
-1.0E12
Maximum Value:1.0E12
Billable Service Quantity -
unitOfMeasure: string
Maximum Length:
30
Unit of Measure
Nested Schema : items
Type:
Show Source
object
-
calculatedAmount: number
Calculated Amount
-
calculationLines: object
calculationLines
-
descriptionOnBill: string
Maximum Length:
254
Description on Bill -
endDate: string
(date)
End Date
-
headerSequence: number
Minimum Value:
-999
Maximum Value:999
Header Sequence -
rateVersion: object
rateVersion
-
startDate: string
(date)
Start Date
Nested Schema : rateVersion
Type:
Show Source
object
-
_link: string
_link
-
effectiveDate: string
(date)
Effective Date
-
rateSchedule: string
Maximum Length:
8
Rate Schedule -
rateScheduleDescription: string
Maximum Length:
60
Description
Nested Schema : items
Type:
Show Source
object
-
calculatedAmount: number
Calculated Amount
-
descriptionOnBill: string
Maximum Length:
254
Description on Bill -
sequence: number
Minimum Value:
-99999
Maximum Value:99999
Sequence -
shouldAppearInSummary: boolean
The Appears in Summary switch defines if this line's amount also appears on a summary line.Example:
true
-
shouldPrint: boolean
The Print switch controls whether information about this line will print on the customer's bill.Example:
true
400 Response
Bad Request
Root Schema : problemDetailDocument
Type:
Show Source
object
-
detail: string
Maximum Length:
60
The long message description from the Oracle Utilities Application Framework in CDATA format. -
httpStatus: number
Minimum Value:
0
Maximum Value:9999
The HTTP Status code for the error. -
problemInstance: string
Maximum Length:
60
Fully qualified URL consisting of the Base URI Timestamp of error in ISO format, the User used for the transaction, the Message Category within Oracle Utilities Application Framework, the Message Number within Oracle Utilities Application Framework, the Request URL and the HTTP method used for the transaction. -
problemType: string
Maximum Length:
60
URL of the format "A/message/X/Y" where A is the base URI, X is the Message Category and Y is the Message Number within Oracle Utilities Application Framework. -
serverMessage: object
serverMessage
-
stackTrace: string
Maximum Length:
60
The stack trace shows where the error occurs during the execution of a program. -
title: string
Maximum Length:
60
Fully qualified error message from Oracle Utilities Application Framework in CDATA format.
Nested Schema : serverMessage
Type:
Show Source
object
-
callSequence: string
Maximum Length:
60
Delimited sequence of programs called. -
longDescription: string
Maximum Length:
60
The long message description from the Oracle Utilities Application Framework in CDATA format. -
messageCategory: number
Minimum Value:
0
Maximum Value:0
Message Category within Oracle Utilities Application Framework. -
messageNbr: number
Minimum Value:
-99999
Maximum Value:99999
Message Number within Oracle Utilities Application Framework. -
messageText: string
Maximum Length:
60
Fully qualified error message from Oracle Utilities Application Framework in CDATA format. -
programName: string
Maximum Length:
60
Name of the program that encountered the error.
500 Response
Internal Server Error
Root Schema : problemDetailDocument
Type:
Show Source
object
-
detail: string
Maximum Length:
60
The long message description from the Oracle Utilities Application Framework in CDATA format. -
httpStatus: number
Minimum Value:
0
Maximum Value:9999
The HTTP Status code for the error. -
problemInstance: string
Maximum Length:
60
Fully qualified URL consisting of the Base URI Timestamp of error in ISO format, the User used for the transaction, the Message Category within Oracle Utilities Application Framework, the Message Number within Oracle Utilities Application Framework, the Request URL and the HTTP method used for the transaction. -
problemType: string
Maximum Length:
60
URL of the format "A/message/X/Y" where A is the base URI, X is the Message Category and Y is the Message Number within Oracle Utilities Application Framework. -
serverMessage: object
serverMessage
-
stackTrace: string
Maximum Length:
60
The stack trace shows where the error occurs during the execution of a program. -
title: string
Maximum Length:
60
Fully qualified error message from Oracle Utilities Application Framework in CDATA format.
Nested Schema : serverMessage
Type:
Show Source
object
-
callSequence: string
Maximum Length:
60
Delimited sequence of programs called. -
longDescription: string
Maximum Length:
60
The long message description from the Oracle Utilities Application Framework in CDATA format. -
messageCategory: number
Minimum Value:
0
Maximum Value:0
Message Category within Oracle Utilities Application Framework. -
messageNbr: number
Minimum Value:
-99999
Maximum Value:99999
Message Number within Oracle Utilities Application Framework. -
messageText: string
Maximum Length:
60
Fully qualified error message from Oracle Utilities Application Framework in CDATA format. -
programName: string
Maximum Length:
60
Name of the program that encountered the error.