Billed Usage for SA
post
https://server:port/spl/rest/apis/customer/usage/usageData/serviceAgreementBilledUsage
Request
There are no request parameters for this operation.
Supported Media Types
- application/xml
- application/json
Nested Schema : items
Type:
Show Source
object
-
endDate: string
(date)
The end date for the service agreement.Example:
2022-12-20
-
serviceAgreementId: string
Maximum Length:
10
The bill segment's service agreement unique identifier. -
startDate: string
(date)
The start date for the service agreement.Example:
2022-12-20
Nested Schema : items
Type:
Show Source
object
-
endDate: string
(date)
The end date for the service agreement.Example:
2022-12-20
-
serviceAgreementId: string
Maximum Length:
10
The bill segment's service agreement unique identifier. -
startDate: string
(date)
The start date for the service agreement.Example:
2022-12-20
Response
Supported Media Types
- application/xml
- application/json
200 Response
Success response
Nested Schema : serviceAgreementDetails
Type:
Show Source
object
-
billSegments: array
billSegments
-
currency: object
currency
Defines the currency in which the account's financial transactions are expressed.
-
endDate: string
(date)
The end date for the service agreement.Example:
2022-12-20
-
graphUnitOfMeasure: string
Maximum Length:
30
The unit of measure defined on the service agreement used to plot a graph of billed usage over timeExample:KWH
-
serviceAgreementId: string
Maximum Length:
10
The bill segment's service agreement unique identifier. -
serviceType: string
Maximum Length:
80
The type of service associated with the service agreement.Example:W
-
startDate: string
(date)
The start date for the service agreement.Example:
2022-12-20
Nested Schema : currency
Type:
object
Defines the currency in which the account's financial transactions are expressed.
Show Source
-
_link: string
_link
-
currency: string
Maximum Length:
3
Defines the currency in which the account's financial transactions are expressed.Example:USD
Nested Schema : items
Type:
Show Source
object
-
billDate: string
(date)
The business date that was used when the bill was generated.
-
billSegmentId: string
Maximum Length:
12
The system-assigned unique identifier of the bill segment. -
endDate: string
(date)
The end of the period of time covered by the bill segment's charges. The bill period is exclusive of this datetime value.Example:
2021-01-01
-
estimated: boolean
Indicates whether or not the usage value was estimated.Example:
true
-
startDate: string
(date)
The start of the period of time covered by the bill segment's charges. The bill period is inclusive of this datetime value.Example:
2020-01-01
-
totalAmount: number
Sum of amounts from financial transactions for the bill's non-canceled segments.
-
usage: array
usage
Nested Schema : items
Type:
Show Source
object
-
serviceQuantityIdentifer: string
Maximum Length:
30
Service quantity identifiers provide additional classification of values when a combination of unit of measure and time of use is inadequate to uniquely classify the value. For example, the service quantity identifiers Consumed and Generated can distinguish between KWH Off-Peak Consumed and KWH Off-Peak Generated.Example:DAMT (Daily Amount)
-
timeOfUse: string
Maximum Length:
30
The time-of-use classification of the bill segment's service quantity.Example:OFF
-
unitOfMeasure: string
Maximum Length:
30
The unit of measure of the bill segments's usage value.Example:KWH
-
usageIdentifier: string
Maximum Length:
100
An identifier for the bill segment usage, provided in the format of KWH--(Unit of Measure-Time of Use-Service Quantity Identifier), with blank values represented with the dash character '-'.Example:KWH--(UOM-TOU-SQI)
-
usageValue: number
Minimum Value:
0
Maximum Value:9999.999999
The total usage value. Refer to the defined unit of measure for complete context of this value.Example:31743.8
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.