Oracle Utilities REST API for Metering and Customer Information

Get Account Non Cash Deposits

get

/rest/apis/customer/v-model/accounts/{accountId}/nonCashDeposits

This operation retrieves non cash deposits for an account.

Request

Path Parameters

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

Query Parameters

includeHistory: boolean
Include old dates records
Example:
```
true
```
limit: number
Page 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 : C1CxAccNCDep

Type: object

Show Source

_self: string

_self
account: object account
hasMore: boolean

Has More
limit: number

Minimum Value: 0

Maximum Value: 999999999.999999

Page Limit

Example: 25
nonCashDeposits: object nonCashDeposits
offset: number

Minimum Value: 0

Maximum Value: 999999999.999999

Offset

Example: 0
totalNumberOfRecords: number

Minimum Value: 0

Maximum Value: 99999

Total Number Of Records

{
    "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":"1589809032"
                },
                "_link":{
                    "type":"string",
                    "description":"_link"
                }
            }
        },
        "offset":{
            "type":"number",
            "maximum":"999999999.999999",
            "minimum":0,
            "description":"Offset",
            "example":"0"
        },
        "limit":{
            "type":"number",
            "maximum":"999999999.999999",
            "minimum":0,
            "description":"Page Limit",
            "example":"25"
        },
        "totalNumberOfRecords":{
            "type":"number",
            "maximum":99999,
            "minimum":0,
            "description":"Total Number Of Records"
        },
        "hasMore":{
            "type":"boolean",
            "description":"Has More"
        },
        "nonCashDeposits":{
            "type":"object",
            "properties":{
                "_data":{
                    "type":"array",
                    "items":{
                        "type":"object",
                        "properties":{
                            "sequence":{
                                "type":"number",
                                "maximum":99999,
                                "minimum":-99999,
                                "description":"A sequence is used to define the order of the records."
                            },
                            "nonCashDepositType":{
                                "type":"object",
                                "properties":{
                                    "nonCashDepositType":{
                                        "type":"string",
                                        "maxLength":8,
                                        "description":"Non-Cash Deposit Type"
                                    },
                                    "_link":{
                                        "type":"string",
                                        "description":"_link"
                                    }
                                }
                            },
                            "depositClass":{
                                "type":"object",
                                "properties":{
                                    "depositClass":{
                                        "type":"string",
                                        "maxLength":8,
                                        "description":"Deposit Class"
                                    },
                                    "_link":{
                                        "type":"string",
                                        "description":"_link"
                                    }
                                }
                            },
                            "startDate":{
                                "type":"string",
                                "format":"date",
                                "description":"Start Date indicates the date on which the alert starts showing for the account.",
                                "example":"2001-01-01"
                            },
                            "endDate":{
                                "type":"string",
                                "format":"date",
                                "description":"End Date indicates the date on which the alert stops showing for the account.",
                                "example":"2001-01-01"
                            },
                            "depositAmount":{
                                "type":"number",
                                "description":"Deposit Amount"
                            },
                            "documentNumber":{
                                "type":"string",
                                "maxLength":20,
                                "description":"Document Number"
                            },
                            "thirdPartySa":{
                                "type":"object",
                                "properties":{
                                    "thirdPartySa":{
                                        "type":"string",
                                        "maxLength":10,
                                        "description":"Service Agreement"
                                    },
                                    "_link":{
                                        "type":"string",
                                        "description":"_link"
                                    }
                                }
                            },
                            "comments":{
                                "type":"string",
                                "maxLength":254,
                                "description":"Comments can describe anything interesting / unusual about the automatic payment request."
                            },
                            "version":{
                                "type":"number",
                                "maximum":99999,
                                "minimum":-99999,
                                "description":"The version number is used for internal concurrency checks.",
                                "example":"2"
                            }
                        }
                    }
                }
            }
        }
    },
    "xml":{
        "name":"C1CxAccNCDep"
    }
}

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

{
    "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":"1589809032"
        },
        "_link":{
            "type":"string",
            "description":"_link"
        }
    }
}

Nested Schema : nonCashDeposits

Type: object

Show Source

_data: array _data

{
    "type":"object",
    "properties":{
        "_data":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "sequence":{
                        "type":"number",
                        "maximum":99999,
                        "minimum":-99999,
                        "description":"A sequence is used to define the order of the records."
                    },
                    "nonCashDepositType":{
                        "type":"object",
                        "properties":{
                            "nonCashDepositType":{
                                "type":"string",
                                "maxLength":8,
                                "description":"Non-Cash Deposit Type"
                            },
                            "_link":{
                                "type":"string",
                                "description":"_link"
                            }
                        }
                    },
                    "depositClass":{
                        "type":"object",
                        "properties":{
                            "depositClass":{
                                "type":"string",
                                "maxLength":8,
                                "description":"Deposit Class"
                            },
                            "_link":{
                                "type":"string",
                                "description":"_link"
                            }
                        }
                    },
                    "startDate":{
                        "type":"string",
                        "format":"date",
                        "description":"Start Date indicates the date on which the alert starts showing for the account.",
                        "example":"2001-01-01"
                    },
                    "endDate":{
                        "type":"string",
                        "format":"date",
                        "description":"End Date indicates the date on which the alert stops showing for the account.",
                        "example":"2001-01-01"
                    },
                    "depositAmount":{
                        "type":"number",
                        "description":"Deposit Amount"
                    },
                    "documentNumber":{
                        "type":"string",
                        "maxLength":20,
                        "description":"Document Number"
                    },
                    "thirdPartySa":{
                        "type":"object",
                        "properties":{
                            "thirdPartySa":{
                                "type":"string",
                                "maxLength":10,
                                "description":"Service Agreement"
                            },
                            "_link":{
                                "type":"string",
                                "description":"_link"
                            }
                        }
                    },
                    "comments":{
                        "type":"string",
                        "maxLength":254,
                        "description":"Comments can describe anything interesting / unusual about the automatic payment request."
                    },
                    "version":{
                        "type":"number",
                        "maximum":99999,
                        "minimum":-99999,
                        "description":"The version number is used for internal concurrency checks.",
                        "example":"2"
                    }
                }
            }
        }
    }
}

Nested Schema : _data

Type: array

Show Source

Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "sequence":{
                "type":"number",
                "maximum":99999,
                "minimum":-99999,
                "description":"A sequence is used to define the order of the records."
            },
            "nonCashDepositType":{
                "type":"object",
                "properties":{
                    "nonCashDepositType":{
                        "type":"string",
                        "maxLength":8,
                        "description":"Non-Cash Deposit Type"
                    },
                    "_link":{
                        "type":"string",
                        "description":"_link"
                    }
                }
            },
            "depositClass":{
                "type":"object",
                "properties":{
                    "depositClass":{
                        "type":"string",
                        "maxLength":8,
                        "description":"Deposit Class"
                    },
                    "_link":{
                        "type":"string",
                        "description":"_link"
                    }
                }
            },
            "startDate":{
                "type":"string",
                "format":"date",
                "description":"Start Date indicates the date on which the alert starts showing for the account.",
                "example":"2001-01-01"
            },
            "endDate":{
                "type":"string",
                "format":"date",
                "description":"End Date indicates the date on which the alert stops showing for the account.",
                "example":"2001-01-01"
            },
            "depositAmount":{
                "type":"number",
                "description":"Deposit Amount"
            },
            "documentNumber":{
                "type":"string",
                "maxLength":20,
                "description":"Document Number"
            },
            "thirdPartySa":{
                "type":"object",
                "properties":{
                    "thirdPartySa":{
                        "type":"string",
                        "maxLength":10,
                        "description":"Service Agreement"
                    },
                    "_link":{
                        "type":"string",
                        "description":"_link"
                    }
                }
            },
            "comments":{
                "type":"string",
                "maxLength":254,
                "description":"Comments can describe anything interesting / unusual about the automatic payment request."
            },
            "version":{
                "type":"number",
                "maximum":99999,
                "minimum":-99999,
                "description":"The version number is used for internal concurrency checks.",
                "example":"2"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

comments: string

Maximum Length: 254

Comments can describe anything interesting / unusual about the automatic payment request.
depositAmount: number

Deposit Amount
depositClass: object depositClass
documentNumber: string

Maximum Length: 20

Document Number
endDate: string (date)

End Date indicates the date on which the alert stops showing for the account.

Example: 2001-01-01
nonCashDepositType: object nonCashDepositType
sequence: number

Minimum Value: -99999

Maximum Value: 99999

A sequence is used to define the order of the records.
startDate: string (date)

Start Date indicates the date on which the alert starts showing for the account.

Example: 2001-01-01
thirdPartySa: object thirdPartySa
version: number

Minimum Value: -99999

Maximum Value: 99999

The version number is used for internal concurrency checks.

Example: 2

{
    "type":"object",
    "properties":{
        "sequence":{
            "type":"number",
            "maximum":99999,
            "minimum":-99999,
            "description":"A sequence is used to define the order of the records."
        },
        "nonCashDepositType":{
            "type":"object",
            "properties":{
                "nonCashDepositType":{
                    "type":"string",
                    "maxLength":8,
                    "description":"Non-Cash Deposit Type"
                },
                "_link":{
                    "type":"string",
                    "description":"_link"
                }
            }
        },
        "depositClass":{
            "type":"object",
            "properties":{
                "depositClass":{
                    "type":"string",
                    "maxLength":8,
                    "description":"Deposit Class"
                },
                "_link":{
                    "type":"string",
                    "description":"_link"
                }
            }
        },
        "startDate":{
            "type":"string",
            "format":"date",
            "description":"Start Date indicates the date on which the alert starts showing for the account.",
            "example":"2001-01-01"
        },
        "endDate":{
            "type":"string",
            "format":"date",
            "description":"End Date indicates the date on which the alert stops showing for the account.",
            "example":"2001-01-01"
        },
        "depositAmount":{
            "type":"number",
            "description":"Deposit Amount"
        },
        "documentNumber":{
            "type":"string",
            "maxLength":20,
            "description":"Document Number"
        },
        "thirdPartySa":{
            "type":"object",
            "properties":{
                "thirdPartySa":{
                    "type":"string",
                    "maxLength":10,
                    "description":"Service Agreement"
                },
                "_link":{
                    "type":"string",
                    "description":"_link"
                }
            }
        },
        "comments":{
            "type":"string",
            "maxLength":254,
            "description":"Comments can describe anything interesting / unusual about the automatic payment request."
        },
        "version":{
            "type":"number",
            "maximum":99999,
            "minimum":-99999,
            "description":"The version number is used for internal concurrency checks.",
            "example":"2"
        }
    }
}

Nested Schema : depositClass

Type: object

Show Source

_link: string

_link
depositClass: string

Maximum Length: 8

Deposit Class

{
    "type":"object",
    "properties":{
        "depositClass":{
            "type":"string",
            "maxLength":8,
            "description":"Deposit Class"
        },
        "_link":{
            "type":"string",
            "description":"_link"
        }
    }
}

Nested Schema : nonCashDepositType

Type: object

Show Source

_link: string

_link
nonCashDepositType: string

Maximum Length: 8

Non-Cash Deposit Type

{
    "type":"object",
    "properties":{
        "nonCashDepositType":{
            "type":"string",
            "maxLength":8,
            "description":"Non-Cash Deposit Type"
        },
        "_link":{
            "type":"string",
            "description":"_link"
        }
    }
}

Nested Schema : thirdPartySa

Type: object

Show Source

_link: string

_link
thirdPartySa: string

Maximum Length: 10

Service Agreement

{
    "type":"object",
    "properties":{
        "thirdPartySa":{
            "type":"string",
            "maxLength":10,
            "description":"Service Agreement"
        },
        "_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."
        }
    }
}