Oracle Utilities REST API for Metering and Customer Information

Get Account Financial Details

get

/rest/apis/customer/financials/accountData/{accountId}/financialDetails

This operation retrieves the Financial details for the provided Account Id.

Request

Path Parameters

accountId(required): string
The Account ID is a system-assigned random number that stays with an account for life.
Example:
```
1589800000
```

Query Parameters

extendedHistory: boolean
If Extended History parameter has value true, response contains financial details of the account and billedAmountYTD information
Example:
```
true
```

There's no request body for this operation.

Response

Supported Media Types

application/xml
application/json

200 Response

Success response

Root Schema : C1FinDetails

Type: object

Show Source

_self: string

_self
account: object account
arrearsDetails: object arrearsDetails
autoPaySourceCode: string

Maximum Length: 12

Auto Pay Source is used to define the source of the funds, such as a banking institution, used to satisfy the automatic payment request.

Example: AMEX
autoPaySourceDescr: string

Maximum Length: 60

Auto Pay Source Description defines the source of the funds, such as a banking institution, used to satisfy the automatic payment request.
billedAmountYTD: number

Billed Amount Year-to-date

Example: 600.25
currency: object currency

Currency Code defines the currency in which the account's financial transactions are expressed.
currentBalance: number

Current Balance shows the account's current balance after the financial event.

Example: 48337.45
currentCreditRating: number

Minimum Value: 0

Maximum Value: 0

Current Credit Rating

Example: 800
depositAmount: number

Amount of the non-cash deposit

Example: 0
lastBill: object lastBill
lastPayment: object lastPayment
nextBillDate: string (date)

Bill Date
nextCreditReviewDate: string (date)

The next date on which the account's debt will be reviewed by the account debt monitor process.

Example: 2022-05-11
onTimePaymentsLast12Months: number

Minimum Value: 0

Maximum Value: 1000000000000000000000000000000

On-Time payment Last 12 months

Example: 43%
payoffBalance: number

Payoff Balance shows the account's payoff balance after the financial event.

Example: 48337.45

{
    "type":"object",
    "properties":{
        "_self":{
            "type":"string",
            "description":"_self"
        },
        "account":{
            "type":"object",
            "properties":{
                "accountId":{
                    "type":"string",
                    "maxLength":"10",
                    "description":"The Account ID is a system-assigned random number that stays with an account for life.",
                    "example":"1589800000"
                },
                "isActive":{
                    "type":"boolean",
                    "description":"The Account ID is a system-assigned random number that stays with an account for life.",
                    "example":"1589800000"
                },
                "inactiveDate":{
                    "type":"string",
                    "format":"date",
                    "description":"The Account ID is a system-assigned random number that stays with an account for life.",
                    "example":"1589800000"
                },
                "_link":{
                    "type":"string",
                    "description":"_link"
                }
            }
        },
        "currentBalance":{
            "type":"number",
            "description":"Current Balance shows the account's current balance after the financial event.",
            "example":"48337.45"
        },
        "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"
                }
            }
        },
        "arrearsDetails":{
            "type":"object",
            "properties":{
                "_data":{
                    "type":"array",
                    "items":{
                        "type":"object",
                        "properties":{
                            "sortGroup":{
                                "type":"number",
                                "maximum":"99999",
                                "minimum":"0",
                                "description":"Sort Group"
                            },
                            "dayAge":{
                                "type":"number",
                                "maximum":"99999",
                                "minimum":"-99999",
                                "description":"The Days Aged and Arrears Amount information shows how old the current balance is.",
                                "example":"8558"
                            },
                            "dayAgeDescription":{
                                "type":"string",
                                "maxLength":"30",
                                "description":"Day Age Description"
                            },
                            "arrearsAmount":{
                                "type":"number",
                                "description":"The Days Aged and Arrears Amount information shows how old the current balance is.",
                                "example":"2062.26"
                            }
                        }
                    }
                }
            }
        },
        "lastBill":{
            "type":"object",
            "properties":{
                "bill":{
                    "type":"object",
                    "properties":{
                        "billId":{
                            "type":"string",
                            "maxLength":"12",
                            "description":"Bill ID is the system-assigned unique identifier of the bill.",
                            "example":"549133128888"
                        },
                        "_link":{
                            "type":"string",
                            "description":"_link"
                        }
                    }
                },
                "billDate":{
                    "type":"string",
                    "format":"date",
                    "description":"Bill Date"
                },
                "billDueDate":{
                    "type":"string",
                    "format":"date",
                    "description":"Due Date is the date on which the bill is due.",
                    "example":"1999-10-11"
                },
                "billAmount":{
                    "type":"number",
                    "description":"Current Charges"
                }
            }
        },
        "nextBillDate":{
            "type":"string",
            "format":"date",
            "description":"Bill Date"
        },
        "autoPaySourceCode":{
            "type":"string",
            "maxLength":"12",
            "description":"Auto Pay Source is used to define the source of the funds, such as a banking institution, used to satisfy the automatic payment request.",
            "example":"AMEX"
        },
        "autoPaySourceDescr":{
            "type":"string",
            "maxLength":"60",
            "description":"Auto Pay Source Description defines the source of the funds, such as a banking institution, used to satisfy the automatic payment request."
        },
        "depositAmount":{
            "type":"number",
            "description":"Amount of the non-cash deposit",
            "example":"0"
        },
        "payoffBalance":{
            "type":"number",
            "description":"Payoff Balance  shows the account's payoff balance after the financial event.",
            "example":"48337.45"
        },
        "currentCreditRating":{
            "type":"number",
            "maximum":"0",
            "minimum":"0",
            "description":"Current Credit Rating",
            "example":"800"
        },
        "nextCreditReviewDate":{
            "type":"string",
            "format":"date",
            "description":"The next date on which the account's debt will be reviewed by the account debt monitor process.",
            "example":"2022-05-11"
        },
        "lastPayment":{
            "type":"object",
            "properties":{
                "payment":{
                    "type":"object",
                    "properties":{
                        "paymentId":{
                            "type":"string",
                            "maxLength":"12",
                            "description":"Payment ID is the system-assigned, unique identifier of the payment to which the financial transaction is linked.",
                            "example":"025898353555"
                        },
                        "_link":{
                            "type":"string",
                            "description":"_link"
                        }
                    }
                },
                "paymentAmount":{
                    "type":"number",
                    "description":"Payment Amount is the amount of the payment.",
                    "example":"1"
                },
                "paymentDate":{
                    "type":"string",
                    "format":"date",
                    "description":"Payment date",
                    "example":"2021-06-08"
                }
            }
        },
        "billedAmountYTD":{
            "type":"number",
            "description":"Billed Amount Year-to-date",
            "example":"600.25"
        },
        "onTimePaymentsLast12Months":{
            "type":"number",
            "maximum":"1000000000000000000000000000000",
            "minimum":"0",
            "description":"On-Time payment Last 12 months",
            "example":"43%"
        }
    },
    "xml":{
        "name":"C1FinDetails"
    }
}

Nested Schema : account

Type: object

Show Source

_link: string

_link
accountId: string

Maximum Length: 10

The Account ID is a system-assigned random number that stays with an account for life.

Example: 1589800000
inactiveDate: string (date)

The Account ID is a system-assigned random number that stays with an account for life.

Example: 1589800000
isActive: boolean

The Account ID is a system-assigned random number that stays with an account for life.

Example: 1589800000

{
    "type":"object",
    "properties":{
        "accountId":{
            "type":"string",
            "maxLength":"10",
            "description":"The Account ID is a system-assigned random number that stays with an account for life.",
            "example":"1589800000"
        },
        "isActive":{
            "type":"boolean",
            "description":"The Account ID is a system-assigned random number that stays with an account for life.",
            "example":"1589800000"
        },
        "inactiveDate":{
            "type":"string",
            "format":"date",
            "description":"The Account ID is a system-assigned random number that stays with an account for life.",
            "example":"1589800000"
        },
        "_link":{
            "type":"string",
            "description":"_link"
        }
    }
}

Nested Schema : arrearsDetails

Type: object

Show Source

_data: array _data

{
    "type":"object",
    "properties":{
        "_data":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "sortGroup":{
                        "type":"number",
                        "maximum":"99999",
                        "minimum":"0",
                        "description":"Sort Group"
                    },
                    "dayAge":{
                        "type":"number",
                        "maximum":"99999",
                        "minimum":"-99999",
                        "description":"The Days Aged and Arrears Amount information shows how old the current balance is.",
                        "example":"8558"
                    },
                    "dayAgeDescription":{
                        "type":"string",
                        "maxLength":"30",
                        "description":"Day Age Description"
                    },
                    "arrearsAmount":{
                        "type":"number",
                        "description":"The Days Aged and Arrears Amount information shows how old the current balance is.",
                        "example":"2062.26"
                    }
                }
            }
        }
    }
}

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 : lastBill

Type: object

Show Source

bill: object bill
billAmount: number

Current Charges
billDate: string (date)

Bill Date
billDueDate: string (date)

Due Date is the date on which the bill is due.

Example: 1999-10-11

{
    "type":"object",
    "properties":{
        "bill":{
            "type":"object",
            "properties":{
                "billId":{
                    "type":"string",
                    "maxLength":"12",
                    "description":"Bill ID is the system-assigned unique identifier of the bill.",
                    "example":"549133128888"
                },
                "_link":{
                    "type":"string",
                    "description":"_link"
                }
            }
        },
        "billDate":{
            "type":"string",
            "format":"date",
            "description":"Bill Date"
        },
        "billDueDate":{
            "type":"string",
            "format":"date",
            "description":"Due Date is the date on which the bill is due.",
            "example":"1999-10-11"
        },
        "billAmount":{
            "type":"number",
            "description":"Current Charges"
        }
    }
}

Nested Schema : lastPayment

Type: object

Show Source

payment: object payment
paymentAmount: number

Payment Amount is the amount of the payment.

Example: 1
paymentDate: string (date)

Payment date

Example: 2021-06-08

{
    "type":"object",
    "properties":{
        "payment":{
            "type":"object",
            "properties":{
                "paymentId":{
                    "type":"string",
                    "maxLength":"12",
                    "description":"Payment ID is the system-assigned, unique identifier of the payment to which the financial transaction is linked.",
                    "example":"025898353555"
                },
                "_link":{
                    "type":"string",
                    "description":"_link"
                }
            }
        },
        "paymentAmount":{
            "type":"number",
            "description":"Payment Amount is the amount of the payment.",
            "example":"1"
        },
        "paymentDate":{
            "type":"string",
            "format":"date",
            "description":"Payment date",
            "example":"2021-06-08"
        }
    }
}

Nested Schema : _data

Type: array

Show Source

Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "sortGroup":{
                "type":"number",
                "maximum":"99999",
                "minimum":"0",
                "description":"Sort Group"
            },
            "dayAge":{
                "type":"number",
                "maximum":"99999",
                "minimum":"-99999",
                "description":"The Days Aged and Arrears Amount information shows how old the current balance is.",
                "example":"8558"
            },
            "dayAgeDescription":{
                "type":"string",
                "maxLength":"30",
                "description":"Day Age Description"
            },
            "arrearsAmount":{
                "type":"number",
                "description":"The Days Aged and Arrears Amount information shows how old the current balance is.",
                "example":"2062.26"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

arrearsAmount: number

The Days Aged and Arrears Amount information shows how old the current balance is.

Example: 2062.26
dayAge: number

Minimum Value: -99999

Maximum Value: 99999

The Days Aged and Arrears Amount information shows how old the current balance is.

Example: 8558
dayAgeDescription: string

Maximum Length: 30

Day Age Description
sortGroup: number

Minimum Value: 0

Maximum Value: 99999

Sort Group

{
    "type":"object",
    "properties":{
        "sortGroup":{
            "type":"number",
            "maximum":"99999",
            "minimum":"0",
            "description":"Sort Group"
        },
        "dayAge":{
            "type":"number",
            "maximum":"99999",
            "minimum":"-99999",
            "description":"The Days Aged and Arrears Amount information shows how old the current balance is.",
            "example":"8558"
        },
        "dayAgeDescription":{
            "type":"string",
            "maxLength":"30",
            "description":"Day Age Description"
        },
        "arrearsAmount":{
            "type":"number",
            "description":"The Days Aged and Arrears Amount information shows how old the current balance is.",
            "example":"2062.26"
        }
    }
}

Nested Schema : bill

Type: object

Show Source

_link: string

_link
billId: string

Maximum Length: 12

Bill ID is the system-assigned unique identifier of the bill.

Example: 549133128888

{
    "type":"object",
    "properties":{
        "billId":{
            "type":"string",
            "maxLength":"12",
            "description":"Bill ID is the system-assigned unique identifier of the bill.",
            "example":"549133128888"
        },
        "_link":{
            "type":"string",
            "description":"_link"
        }
    }
}

Nested Schema : payment

Type: object

Show Source

_link: string

_link
paymentId: string

Maximum Length: 12

Payment ID is the system-assigned, unique identifier of the payment to which the financial transaction is linked.

Example: 025898353555

{
    "type":"object",
    "properties":{
        "paymentId":{
            "type":"string",
            "maxLength":"12",
            "description":"Payment ID is the system-assigned, unique identifier of the payment to which the financial transaction is linked.",
            "example":"025898353555"
        },
        "_link":{
            "type":"string",
            "description":"_link"
        }
    }
}

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."
        }
    }
}