SA UOMs and Financial Statistics
get
/rest/apis/customer/financials/saData/billingDetails/{serviceAgreementId}
Request
Path Parameters
-
serviceAgreementId(required): string
The bill segment's service agreement unique identifier.Example:
0014198670
Query Parameters
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/xml
- application/json
200 Response
Success response
Root Schema : C1SAStats
Type:
Show Source
object
-
effectiveRate: object
effectiveRate
-
financials: object
financials
-
saId: string
Maximum Length:
10
The bill segment's service agreement unique identifier.Example:0014198670
-
spsLinkedCount: number
Minimum Value:
0
Maximum Value:99999
The count of service points linked to a Service Agreement.Example:1
-
uoms: object
uoms
-
usageDataAvailabilityIndicators: object
usageDataAvailabilityIndicators
Nested Schema : effectiveRate
Type:
Show Source
object
-
description: string
Maximum Length:
60
Description for the rate schedule to provide further context on the rate.Example:Electric residential stepped daily minimum
-
frequency: string
Maximum Length:
8
Frequency of the effective rate.Example:Q
-
frequencyDescription: string
Maximum Length:
60
A description for the frequency of an effective rate, which can be displayed to customers.Example:Quarterly
-
periodsPerYear: number
Minimum Value:
-999
Maximum Value:999
The count of periods per year for an effective rate, which is determined based upon an effective rate's frequency.Example:4
-
rate: string
Maximum Length:
8
Rate Schedule defines the rate linked to the rate version.Example:ERES-1
Nested Schema : financials
Type:
Show Source
object
-
currency: object
currency
Currency Code defines the currency in which the account's financial transactions are expressed.
-
currentBalance: number
Current Amount is the bill segment's effect on the service agreement's current balance.Example:
68.75
-
latestBill: object
latestBill
-
payoffBalance: number
Payoff Amount shows the financial event's effect on the account's payoff balance.Example:
68.75
Nested Schema : usageDataAvailabilityIndicators
Type:
Show Source
object
-
isDailyAvailable: string
Maximum Length:
1
Indicator of the granularity level of usage data available for the Service Agreement. When defined as Y, usage data is available at a daily level.Example:Y/N
-
isHourlyAvailable: string
Maximum Length:
1
Indicator of the granularity level of usage data available for the Service Agreement. When defined as Y, usage data is available at an hourly level.Example:Y/N
Nested Schema : currency
Type:
object
Currency Code defines the currency in which the account's financial transactions are expressed.
Show Source
-
_link: string
_link
-
currency: string
Maximum Length:
3
Currency Code defines the currency in which the account's financial transactions are expressed.Example:USD
Nested Schema : latestBill
Type:
Show Source
object
-
billAmount: number
The charge for the latest bill.Example:
41.62
-
billDate: string
(date)
Bill Date is the business date used when the bill was completed.Example:
2001-03-01
-
frozenBillSegment: string
Maximum Length:
12
Bill Segment ID is the system-assigned unique identifier of the bill segment.Example:001419825642
Nested Schema : items
Type:
Show Source
object
-
unitOfMeasure: string
Maximum Length:
30
Unit of Measure is the unit of measurement that describes the values for the service quantity.Example:KWH
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.