Oracle Utilities REST API for Metering and Customer Information

Get Service Agreement UOMs and Financial Statistics

get

https://server:port/spl/rest/apis/customer/financials/saData/billingDetails/{serviceAgreementId}

Retrieves a list of applicable Units of Measure (UOM) for a Service Agreement, as well as financial statistics.

Request

Path Parameters

serviceAgreementId(required): string
The bill segment's service agreement unique identifier.
Example:
```
0014198670
```

There's no request body for this operation.

Response

Supported Media Types

application/xml
application/json

200 Response

Success response

Root Schema : C1SAStats

Type: object

Show Source

effectiveRate: object effectiveRate
financials: object financials
saId: string

Maximum Length: 10

The bill segment's service agreement unique identifier.

Example: 0014198670
uoms: object uoms

{
    "type":"object",
    "properties":{
        "saId":{
            "type":"string",
            "maxLength":10,
            "description":"The bill segment's service agreement unique identifier.",
            "example":"0014198670"
        },
        "uoms":{
            "type":"object",
            "properties":{
                "uomDetails":{
                    "type":"array",
                    "items":{
                        "type":"object",
                        "properties":{
                            "unitOfMeasure":{
                                "type":"string",
                                "maxLength":30,
                                "description":"Unit of Measure is the unit of measurement that describes the values for the service quantity.",
                                "example":"KWH"
                            }
                        }
                    }
                }
            }
        },
        "financials":{
            "type":"object",
            "properties":{
                "currentBalance":{
                    "type":"number",
                    "description":"Current Amount is the bill segment's effect on the service agreement's current balance.",
                    "example":"68.75"
                },
                "payoffBalance":{
                    "type":"number",
                    "description":"Payoff Amount shows the financial event's effect on the account's payoff balance.",
                    "example":"68.75"
                },
                "currency":{
                    "type":"object",
                    "description":"Currency Code defines the currency in which the account's financial transactions are expressed.",
                    "properties":{
                        "currency":{
                            "type":"string",
                            "maxLength":3,
                            "description":"Currency Code defines the currency in which the account's financial transactions are expressed.",
                            "example":"USD"
                        },
                        "_link":{
                            "type":"string",
                            "description":"_link"
                        }
                    }
                },
                "latestBill":{
                    "type":"object",
                    "properties":{
                        "frozenBillSegment":{
                            "type":"string",
                            "maxLength":12,
                            "description":"Bill Segment ID is the system-assigned unique identifier of the bill segment.",
                            "example":"001419825642"
                        },
                        "billDate":{
                            "type":"string",
                            "format":"date",
                            "description":"Bill Date is the business date used when the bill was completed.",
                            "example":"2001-03-01"
                        },
                        "billAmount":{
                            "type":"number",
                            "description":"The charge for the latest bill.",
                            "example":"41.62"
                        }
                    }
                }
            }
        },
        "effectiveRate":{
            "type":"object",
            "properties":{
                "rate":{
                    "type":"string",
                    "maxLength":8,
                    "description":"Rate Schedule defines the rate linked to the rate version.",
                    "example":"ERES-1"
                },
                "description":{
                    "type":"string",
                    "maxLength":60,
                    "description":"Description for the rate schedule to provide further context on the rate.",
                    "example":"Electric residential stepped daily minimum"
                }
            }
        }
    },
    "xml":{
        "name":"C1SAStats"
    }
}

Nested Schema : effectiveRate

Type: object

Show Source

description: string

Maximum Length: 60

Description for the rate schedule to provide further context on the rate.

Example: Electric residential stepped daily minimum
rate: string

Maximum Length: 8

Rate Schedule defines the rate linked to the rate version.

Example: ERES-1

{
    "type":"object",
    "properties":{
        "rate":{
            "type":"string",
            "maxLength":8,
            "description":"Rate Schedule defines the rate linked to the rate version.",
            "example":"ERES-1"
        },
        "description":{
            "type":"string",
            "maxLength":60,
            "description":"Description for the rate schedule to provide further context on the rate.",
            "example":"Electric residential stepped daily minimum"
        }
    }
}

Nested Schema : financials

Type: object

Show Source

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

{
    "type":"object",
    "properties":{
        "currentBalance":{
            "type":"number",
            "description":"Current Amount is the bill segment's effect on the service agreement's current balance.",
            "example":"68.75"
        },
        "payoffBalance":{
            "type":"number",
            "description":"Payoff Amount shows the financial event's effect on the account's payoff balance.",
            "example":"68.75"
        },
        "currency":{
            "type":"object",
            "description":"Currency Code defines the currency in which the account's financial transactions are expressed.",
            "properties":{
                "currency":{
                    "type":"string",
                    "maxLength":3,
                    "description":"Currency Code defines the currency in which the account's financial transactions are expressed.",
                    "example":"USD"
                },
                "_link":{
                    "type":"string",
                    "description":"_link"
                }
            }
        },
        "latestBill":{
            "type":"object",
            "properties":{
                "frozenBillSegment":{
                    "type":"string",
                    "maxLength":12,
                    "description":"Bill Segment ID is the system-assigned unique identifier of the bill segment.",
                    "example":"001419825642"
                },
                "billDate":{
                    "type":"string",
                    "format":"date",
                    "description":"Bill Date is the business date used when the bill was completed.",
                    "example":"2001-03-01"
                },
                "billAmount":{
                    "type":"number",
                    "description":"The charge for the latest bill.",
                    "example":"41.62"
                }
            }
        }
    }
}

Nested Schema : uoms

Type: object

Show Source

uomDetails: array uomDetails

{
    "type":"object",
    "properties":{
        "uomDetails":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "unitOfMeasure":{
                        "type":"string",
                        "maxLength":30,
                        "description":"Unit of Measure is the unit of measurement that describes the values for the service quantity.",
                        "example":"KWH"
                    }
                }
            }
        }
    }
}

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

{
    "type":"object",
    "description":"Currency Code defines the currency in which the account's financial transactions are expressed.",
    "properties":{
        "currency":{
            "type":"string",
            "maxLength":3,
            "description":"Currency Code defines the currency in which the account's financial transactions are expressed.",
            "example":"USD"
        },
        "_link":{
            "type":"string",
            "description":"_link"
        }
    }
}

Nested Schema : latestBill

Type: object

Show Source

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

{
    "type":"object",
    "properties":{
        "frozenBillSegment":{
            "type":"string",
            "maxLength":12,
            "description":"Bill Segment ID is the system-assigned unique identifier of the bill segment.",
            "example":"001419825642"
        },
        "billDate":{
            "type":"string",
            "format":"date",
            "description":"Bill Date is the business date used when the bill was completed.",
            "example":"2001-03-01"
        },
        "billAmount":{
            "type":"number",
            "description":"The charge for the latest bill.",
            "example":"41.62"
        }
    }
}

Nested Schema : uomDetails

Type: array

Show Source

Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "unitOfMeasure":{
                "type":"string",
                "maxLength":30,
                "description":"Unit of Measure is the unit of measurement that describes the values for the service quantity.",
                "example":"KWH"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

unitOfMeasure: string

Maximum Length: 30

Unit of Measure is the unit of measurement that describes the values for the service quantity.

Example: KWH

{
    "type":"object",
    "properties":{
        "unitOfMeasure":{
            "type":"string",
            "maxLength":30,
            "description":"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: object

Show Source

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.

{
    "type":"object",
    "properties":{
        "problemType":{
            "type":"string",
            "maxLength":60,
            "description":"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."
        },
        "title":{
            "type":"string",
            "maxLength":60,
            "description":"Fully qualified error message from Oracle Utilities Application Framework in CDATA format."
        },
        "httpStatus":{
            "type":"number",
            "maximum":9999,
            "minimum":0,
            "description":"The HTTP Status code for the error."
        },
        "detail":{
            "type":"string",
            "maxLength":60,
            "description":"The long message description from the Oracle Utilities Application Framework in CDATA format."
        },
        "problemInstance":{
            "type":"string",
            "maxLength":60,
            "description":"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."
        },
        "stackTrace":{
            "type":"string",
            "maxLength":60,
            "description":"The stack trace shows where the error occurs during the execution of a program."
        },
        "serverMessage":{
            "type":"object",
            "properties":{
                "messageCategory":{
                    "type":"number",
                    "maximum":0,
                    "minimum":0,
                    "description":"Message Category within Oracle Utilities Application Framework."
                },
                "messageNbr":{
                    "type":"number",
                    "maximum":99999,
                    "minimum":-99999,
                    "description":"Message Number within Oracle Utilities Application Framework."
                },
                "callSequence":{
                    "type":"string",
                    "maxLength":60,
                    "description":"Delimited sequence of programs called."
                },
                "programName":{
                    "type":"string",
                    "maxLength":60,
                    "description":"Name of the program that encountered the error."
                },
                "messageText":{
                    "type":"string",
                    "maxLength":60,
                    "description":"Fully qualified error message from Oracle Utilities Application Framework in CDATA format."
                },
                "longDescription":{
                    "type":"string",
                    "maxLength":60,
                    "description":"The long message description from the Oracle Utilities Application Framework in CDATA format."
                }
            }
        }
    }
}

Nested Schema : serverMessage

Type: object

Show Source

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.

{
    "type":"object",
    "properties":{
        "messageCategory":{
            "type":"number",
            "maximum":0,
            "minimum":0,
            "description":"Message Category within Oracle Utilities Application Framework."
        },
        "messageNbr":{
            "type":"number",
            "maximum":99999,
            "minimum":-99999,
            "description":"Message Number within Oracle Utilities Application Framework."
        },
        "callSequence":{
            "type":"string",
            "maxLength":60,
            "description":"Delimited sequence of programs called."
        },
        "programName":{
            "type":"string",
            "maxLength":60,
            "description":"Name of the program that encountered the error."
        },
        "messageText":{
            "type":"string",
            "maxLength":60,
            "description":"Fully qualified error message from Oracle Utilities Application Framework in CDATA format."
        },
        "longDescription":{
            "type":"string",
            "maxLength":60,
            "description":"The long message description from the Oracle Utilities Application Framework in CDATA format."
        }
    }
}

500 Response

Internal Server Error

Root Schema : problemDetailDocument

Type: object

Show Source

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.

{
    "type":"object",
    "properties":{
        "problemType":{
            "type":"string",
            "maxLength":60,
            "description":"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."
        },
        "title":{
            "type":"string",
            "maxLength":60,
            "description":"Fully qualified error message from Oracle Utilities Application Framework in CDATA format."
        },
        "httpStatus":{
            "type":"number",
            "maximum":9999,
            "minimum":0,
            "description":"The HTTP Status code for the error."
        },
        "detail":{
            "type":"string",
            "maxLength":60,
            "description":"The long message description from the Oracle Utilities Application Framework in CDATA format."
        },
        "problemInstance":{
            "type":"string",
            "maxLength":60,
            "description":"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."
        },
        "stackTrace":{
            "type":"string",
            "maxLength":60,
            "description":"The stack trace shows where the error occurs during the execution of a program."
        },
        "serverMessage":{
            "type":"object",
            "properties":{
                "messageCategory":{
                    "type":"number",
                    "maximum":0,
                    "minimum":0,
                    "description":"Message Category within Oracle Utilities Application Framework."
                },
                "messageNbr":{
                    "type":"number",
                    "maximum":99999,
                    "minimum":-99999,
                    "description":"Message Number within Oracle Utilities Application Framework."
                },
                "callSequence":{
                    "type":"string",
                    "maxLength":60,
                    "description":"Delimited sequence of programs called."
                },
                "programName":{
                    "type":"string",
                    "maxLength":60,
                    "description":"Name of the program that encountered the error."
                },
                "messageText":{
                    "type":"string",
                    "maxLength":60,
                    "description":"Fully qualified error message from Oracle Utilities Application Framework in CDATA format."
                },
                "longDescription":{
                    "type":"string",
                    "maxLength":60,
                    "description":"The long message description from the Oracle Utilities Application Framework in CDATA format."
                }
            }
        }
    }
}

Nested Schema : serverMessage

Type: object

Show Source

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.

{
    "type":"object",
    "properties":{
        "messageCategory":{
            "type":"number",
            "maximum":0,
            "minimum":0,
            "description":"Message Category within Oracle Utilities Application Framework."
        },
        "messageNbr":{
            "type":"number",
            "maximum":99999,
            "minimum":-99999,
            "description":"Message Number within Oracle Utilities Application Framework."
        },
        "callSequence":{
            "type":"string",
            "maxLength":60,
            "description":"Delimited sequence of programs called."
        },
        "programName":{
            "type":"string",
            "maxLength":60,
            "description":"Name of the program that encountered the error."
        },
        "messageText":{
            "type":"string",
            "maxLength":60,
            "description":"Fully qualified error message from Oracle Utilities Application Framework in CDATA format."
        },
        "longDescription":{
            "type":"string",
            "maxLength":60,
            "description":"The long message description from the Oracle Utilities Application Framework in CDATA format."
        }
    }
}