Oracle Utilities REST API for Metering and Customer Information

Customer History for a Premise

get

/rest/apis/customer/v-model/billingContext/premiseCustomerHistory/{premiseId}

Request

Path Parameters

premiseId(required): string
Premise ID is a system-assigned, unique identifier that shows the primary premise associated with the service agreement.
Example:
```
3836403369
```

Query Parameters

limit: number
Limit
Example:
```
25
```
offset: number
Offset
Example:
```
0
```

There's no request body for this operation.

Response

Supported Media Types

application/xml
application/json

200 Response

Success response

Root Schema : C1PreCusHist

Type: object

Show Source

accounts: array accounts
limit: number

Minimum Value: 0

Maximum Value: 999999999.999999

Limit

Example: 25
offset: number

Minimum Value: 0

Maximum Value: 999999999.999999

Offset

Example: 0
premiseId: string

Maximum Length: 10

Premise ID is a system-assigned, unique identifier that shows the primary premise associated with the service agreement.

Example: 3836403369
totalNumberOfRecords: number

Minimum Value: 0

Maximum Value: 99999

Total Number Of Records

Example: 2

{
    "type":"object",
    "properties":{
        "premiseId":{
            "type":"string",
            "maxLength":"10",
            "description":"Premise ID is a system-assigned, unique identifier that shows the primary premise associated with the service agreement.",
            "example":"3836403369"
        },
        "limit":{
            "type":"number",
            "maximum":"999999999.999999",
            "minimum":"0",
            "description":"Limit",
            "example":"25"
        },
        "offset":{
            "type":"number",
            "maximum":"999999999.999999",
            "minimum":"0",
            "description":"Offset",
            "example":"0"
        },
        "totalNumberOfRecords":{
            "type":"number",
            "maximum":"99999",
            "minimum":"0",
            "description":"Total Number Of Records",
            "example":"2"
        },
        "accounts":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "accountId":{
                        "type":"string",
                        "maxLength":"10",
                        "description":"Account ID identifies the customer who is responsible for the bill.",
                        "example":"0119532152"
                    },
                    "customerClassDescription":{
                        "type":"string",
                        "maxLength":"60",
                        "description":"Description for Customer class",
                        "example":"Residential"
                    },
                    "relatedPersons":{
                        "type":"array",
                        "items":{
                            "type":"object",
                            "properties":{
                                "personId":{
                                    "type":"string",
                                    "maxLength":"10",
                                    "description":"Person ID is the system-assigned number for other persons related to the account."
                                },
                                "primaryName":{
                                    "type":"string",
                                    "maxLength":"254",
                                    "description":"Name"
                                },
                                "personOrBusiness":{
                                    "type":"string",
                                    "enum":[
                                        "B   ",
                                        "P   "
                                    ],
                                    "description":"Defines the person entity as a person or business, which controls validation of the person entity's primary name.\n* `B   ` - Business,\n* `P   ` - Person",
                                    "example":"P"
                                },
                                "isMainCustomer":{
                                    "type":"boolean",
                                    "description":"Main Customer switch is on if the person is the main customer on the account. Only one person on an account may be designated as the main customer.",
                                    "example":"false"
                                },
                                "isFinanciallyResponsible":{
                                    "type":"boolean",
                                    "description":"Financially Responsible switch is on if the person is financially responsible for the account's debt.",
                                    "example":"true"
                                },
                                "relationshipTypeDescription":{
                                    "type":"string",
                                    "maxLength":"60",
                                    "description":"Description for Customer class",
                                    "example":"Residential"
                                }
                            }
                        }
                    },
                    "startDate":{
                        "type":"string",
                        "format":"date",
                        "description":"Billing Start Date",
                        "example":"2021-09-01"
                    },
                    "endDate":{
                        "type":"string",
                        "format":"date",
                        "description":"Billing End Date",
                        "example":"2021-09-01"
                    },
                    "serviceDetails":{
                        "type":"object",
                        "properties":{
                            "serviceTypes":{
                                "type":"array",
                                "items":{
                                    "type":"object",
                                    "properties":{
                                        "serviceType":{
                                            "type":"string",
                                            "maxLength":"80",
                                            "description":"Service Type defines the type of service associated with the service agreement. For example, G defines the service type as Gas service.",
                                            "example":"G"
                                        }
                                    }
                                }
                            }
                        }
                    }
                }
            }
        }
    },
    "xml":{
        "name":"C1PreCusHist"
    }
}

Nested Schema : accounts

Type: array

Show Source

Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "accountId":{
                "type":"string",
                "maxLength":"10",
                "description":"Account ID identifies the customer who is responsible for the bill.",
                "example":"0119532152"
            },
            "customerClassDescription":{
                "type":"string",
                "maxLength":"60",
                "description":"Description for Customer class",
                "example":"Residential"
            },
            "relatedPersons":{
                "type":"array",
                "items":{
                    "type":"object",
                    "properties":{
                        "personId":{
                            "type":"string",
                            "maxLength":"10",
                            "description":"Person ID is the system-assigned number for other persons related to the account."
                        },
                        "primaryName":{
                            "type":"string",
                            "maxLength":"254",
                            "description":"Name"
                        },
                        "personOrBusiness":{
                            "type":"string",
                            "enum":[
                                "B   ",
                                "P   "
                            ],
                            "description":"Defines the person entity as a person or business, which controls validation of the person entity's primary name.\n* `B   ` - Business,\n* `P   ` - Person",
                            "example":"P"
                        },
                        "isMainCustomer":{
                            "type":"boolean",
                            "description":"Main Customer switch is on if the person is the main customer on the account. Only one person on an account may be designated as the main customer.",
                            "example":"false"
                        },
                        "isFinanciallyResponsible":{
                            "type":"boolean",
                            "description":"Financially Responsible switch is on if the person is financially responsible for the account's debt.",
                            "example":"true"
                        },
                        "relationshipTypeDescription":{
                            "type":"string",
                            "maxLength":"60",
                            "description":"Description for Customer class",
                            "example":"Residential"
                        }
                    }
                }
            },
            "startDate":{
                "type":"string",
                "format":"date",
                "description":"Billing Start Date",
                "example":"2021-09-01"
            },
            "endDate":{
                "type":"string",
                "format":"date",
                "description":"Billing End Date",
                "example":"2021-09-01"
            },
            "serviceDetails":{
                "type":"object",
                "properties":{
                    "serviceTypes":{
                        "type":"array",
                        "items":{
                            "type":"object",
                            "properties":{
                                "serviceType":{
                                    "type":"string",
                                    "maxLength":"80",
                                    "description":"Service Type defines the type of service associated with the service agreement. For example, G defines the service type as Gas service.",
                                    "example":"G"
                                }
                            }
                        }
                    }
                }
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

accountId: string

Maximum Length: 10

Account ID identifies the customer who is responsible for the bill.

Example: 0119532152
customerClassDescription: string

Maximum Length: 60

Description for Customer class

Example: Residential
endDate: string (date)

Billing End Date

Example: 2021-09-01
relatedPersons: array relatedPersons
serviceDetails: object serviceDetails
startDate: string (date)

Billing Start Date

Example: 2021-09-01

{
    "type":"object",
    "properties":{
        "accountId":{
            "type":"string",
            "maxLength":"10",
            "description":"Account ID identifies the customer who is responsible for the bill.",
            "example":"0119532152"
        },
        "customerClassDescription":{
            "type":"string",
            "maxLength":"60",
            "description":"Description for Customer class",
            "example":"Residential"
        },
        "relatedPersons":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "personId":{
                        "type":"string",
                        "maxLength":"10",
                        "description":"Person ID is the system-assigned number for other persons related to the account."
                    },
                    "primaryName":{
                        "type":"string",
                        "maxLength":"254",
                        "description":"Name"
                    },
                    "personOrBusiness":{
                        "type":"string",
                        "enum":[
                            "B   ",
                            "P   "
                        ],
                        "description":"Defines the person entity as a person or business, which controls validation of the person entity's primary name.\n* `B   ` - Business,\n* `P   ` - Person",
                        "example":"P"
                    },
                    "isMainCustomer":{
                        "type":"boolean",
                        "description":"Main Customer switch is on if the person is the main customer on the account. Only one person on an account may be designated as the main customer.",
                        "example":"false"
                    },
                    "isFinanciallyResponsible":{
                        "type":"boolean",
                        "description":"Financially Responsible switch is on if the person is financially responsible for the account's debt.",
                        "example":"true"
                    },
                    "relationshipTypeDescription":{
                        "type":"string",
                        "maxLength":"60",
                        "description":"Description for Customer class",
                        "example":"Residential"
                    }
                }
            }
        },
        "startDate":{
            "type":"string",
            "format":"date",
            "description":"Billing Start Date",
            "example":"2021-09-01"
        },
        "endDate":{
            "type":"string",
            "format":"date",
            "description":"Billing End Date",
            "example":"2021-09-01"
        },
        "serviceDetails":{
            "type":"object",
            "properties":{
                "serviceTypes":{
                    "type":"array",
                    "items":{
                        "type":"object",
                        "properties":{
                            "serviceType":{
                                "type":"string",
                                "maxLength":"80",
                                "description":"Service Type defines the type of service associated with the service agreement. For example, G defines the service type as Gas service.",
                                "example":"G"
                            }
                        }
                    }
                }
            }
        }
    }
}

Nested Schema : relatedPersons

Type: array

Show Source

Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "personId":{
                "type":"string",
                "maxLength":"10",
                "description":"Person ID is the system-assigned number for other persons related to the account."
            },
            "primaryName":{
                "type":"string",
                "maxLength":"254",
                "description":"Name"
            },
            "personOrBusiness":{
                "type":"string",
                "enum":[
                    "B   ",
                    "P   "
                ],
                "description":"Defines the person entity as a person or business, which controls validation of the person entity's primary name.\n* `B   ` - Business,\n* `P   ` - Person",
                "example":"P"
            },
            "isMainCustomer":{
                "type":"boolean",
                "description":"Main Customer switch is on if the person is the main customer on the account. Only one person on an account may be designated as the main customer.",
                "example":"false"
            },
            "isFinanciallyResponsible":{
                "type":"boolean",
                "description":"Financially Responsible switch is on if the person is financially responsible for the account's debt.",
                "example":"true"
            },
            "relationshipTypeDescription":{
                "type":"string",
                "maxLength":"60",
                "description":"Description for Customer class",
                "example":"Residential"
            }
        }
    }
}

Nested Schema : serviceDetails

Type: object

Show Source

serviceTypes: array serviceTypes

{
    "type":"object",
    "properties":{
        "serviceTypes":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "serviceType":{
                        "type":"string",
                        "maxLength":"80",
                        "description":"Service Type defines the type of service associated with the service agreement. For example, G defines the service type as Gas service.",
                        "example":"G"
                    }
                }
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

isFinanciallyResponsible: boolean

Financially Responsible switch is on if the person is financially responsible for the account's debt.

Example: true
isMainCustomer: boolean

Main Customer switch is on if the person is the main customer on the account. Only one person on an account may be designated as the main customer.

Example: false
personId: string

Maximum Length: 10

Person ID is the system-assigned number for other persons related to the account.
personOrBusiness: string

Allowed Values: [ "B ", "P " ]

Defines the person entity as a person or business, which controls validation of the person entity's primary name. * `B ` - Business, * `P ` - Person

Example: P
primaryName: string

Maximum Length: 254

Name
relationshipTypeDescription: string

Maximum Length: 60

Description for Customer class

Example: Residential

{
    "type":"object",
    "properties":{
        "personId":{
            "type":"string",
            "maxLength":"10",
            "description":"Person ID is the system-assigned number for other persons related to the account."
        },
        "primaryName":{
            "type":"string",
            "maxLength":"254",
            "description":"Name"
        },
        "personOrBusiness":{
            "type":"string",
            "enum":[
                "B   ",
                "P   "
            ],
            "description":"Defines the person entity as a person or business, which controls validation of the person entity's primary name.\n* `B   ` - Business,\n* `P   ` - Person",
            "example":"P"
        },
        "isMainCustomer":{
            "type":"boolean",
            "description":"Main Customer switch is on if the person is the main customer on the account. Only one person on an account may be designated as the main customer.",
            "example":"false"
        },
        "isFinanciallyResponsible":{
            "type":"boolean",
            "description":"Financially Responsible switch is on if the person is financially responsible for the account's debt.",
            "example":"true"
        },
        "relationshipTypeDescription":{
            "type":"string",
            "maxLength":"60",
            "description":"Description for Customer class",
            "example":"Residential"
        }
    }
}

Nested Schema : serviceTypes

Type: array

Show Source

Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "serviceType":{
                "type":"string",
                "maxLength":"80",
                "description":"Service Type defines the type of service associated with the service agreement. For example, G defines the service type as Gas service.",
                "example":"G"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

serviceType: string

Maximum Length: 80

Service Type defines the type of service associated with the service agreement. For example, G defines the service type as Gas service.

Example: G

{
    "type":"object",
    "properties":{
        "serviceType":{
            "type":"string",
            "maxLength":"80",
            "description":"Service Type defines the type of service associated with the service agreement. For example, G defines the service type as Gas service.",
            "example":"G"
        }
    }
}

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