Oracle Utilities REST API for Metering and Customer Information

Get Person Collection Details

get

/rest/apis/customer/financials/personData/{personId}/collectionDetails

This operation retrieves collections details including any recent payments for a person.

Request

Path Parameters

personId(required): string
Person ID is a system-assigned random number that stays with a person record for the life of the system.
Example:
```
5775933103
```

There's no request body for this operation.

Response

Supported Media Types

application/xml
application/json

200 Response

Success response

Root Schema : C1PerDebtInf

Type: object

Show Source

collectionsAmounts: object collectionsAmounts
collectionsBillingAccountsCount: number

Minimum Value: 0

Maximum Value: 99999

Number of accounts that are in collections.

Example: 1
creditRatingHigh: number

Minimum Value: -99999

Maximum Value: 99999

The highest credit rating of the accounts in collections.
creditRatingLow: number

Minimum Value: -99999

Maximum Value: 99999

The lowest credit rating of the accounts in collections
currency: object currency

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

Maximum Length: 10

Person ID is a system-assigned random number that stays with a person record for the life of the system.

Example: 5775933103
recentCollectionsAccounts: array recentCollectionsAccounts
recentPaymentDetails: object recentPaymentDetails
systemTimeZoneName: string

Maximum Length: 50

The name of the time zone that is used by the system installation.

Example: US/Pacific

{
    "type":"object",
    "properties":{
        "personId":{
            "type":"string",
            "maxLength":10,
            "description":"Person ID is a system-assigned random number that stays with a person record for the life of the system.",
            "example":"5775933103"
        },
        "systemTimeZoneName":{
            "type":"string",
            "maxLength":50,
            "description":"The name of the time zone that is used by the system installation.",
            "example":"US/Pacific"
        },
        "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"
                }
            }
        },
        "collectionsBillingAccountsCount":{
            "type":"number",
            "maximum":99999,
            "minimum":0,
            "description":"Number of accounts that are in collections.",
            "example":"1"
        },
        "collectionsAmounts":{
            "type":"object",
            "properties":{
                "collectionsTotalAmount":{
                    "type":"number",
                    "description":"Total amount of debt that is overdue in collections.",
                    "example":"260.28"
                },
                "collectionsMinimumAmount":{
                    "type":"number",
                    "description":"Minimum threshold amount required as payment to stop collections/overdue activities.",
                    "example":"182.20"
                },
                "calculationDatetime":{
                    "type":"string",
                    "format":"date-time",
                    "description":"The last time that the system evaluated the collections amounts for the account.",
                    "example":"2024-01-01T00:00:00-08:00"
                }
            }
        },
        "creditRatingLow":{
            "type":"number",
            "maximum":99999,
            "minimum":-99999,
            "description":"The lowest credit rating of the accounts in collections"
        },
        "creditRatingHigh":{
            "type":"number",
            "maximum":99999,
            "minimum":-99999,
            "description":"The highest credit rating of the accounts in collections."
        },
        "recentPaymentDetails":{
            "type":"object",
            "properties":{
                "accountId":{
                    "type":"object",
                    "description":"The Account ID is a system-assigned random number that stays with an account for life.",
                    "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"
                        },
                        "_link":{
                            "type":"string",
                            "description":"_link"
                        }
                    }
                },
                "paymentDate":{
                    "type":"string",
                    "format":"date",
                    "description":"Payment date",
                    "example":"2021-06-08"
                },
                "paymentAmount":{
                    "type":"number",
                    "description":"Payment Amount is the amount of the payment.",
                    "example":"1"
                }
            }
        },
        "recentCollectionsAccounts":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "accountId":{
                        "type":"object",
                        "description":"The Account ID is a system-assigned random number that stays with an account for life.",
                        "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"
                            },
                            "_link":{
                                "type":"string",
                                "description":"_link"
                            }
                        }
                    },
                    "collectionsInitialDate":{
                        "type":"string",
                        "format":"date",
                        "description":"The date that an active collections process started for the person.",
                        "example":"2022-08-08"
                    },
                    "collectionsInitialAmount":{
                        "type":"number",
                        "description":"Initial amount in collections.",
                        "example":"260.28"
                    }
                }
            }
        }
    },
    "xml":{
        "name":"C1PerDebtInf"
    }
}

Nested Schema : collectionsAmounts

Type: object

Show Source

calculationDatetime: string (date-time)

The last time that the system evaluated the collections amounts for the account.

Example: 2024-01-01T00:00:00-08:00
collectionsMinimumAmount: number

Minimum threshold amount required as payment to stop collections/overdue activities.

Example: 182.20
collectionsTotalAmount: number

Total amount of debt that is overdue in collections.

Example: 260.28

{
    "type":"object",
    "properties":{
        "collectionsTotalAmount":{
            "type":"number",
            "description":"Total amount of debt that is overdue in collections.",
            "example":"260.28"
        },
        "collectionsMinimumAmount":{
            "type":"number",
            "description":"Minimum threshold amount required as payment to stop collections/overdue activities.",
            "example":"182.20"
        },
        "calculationDatetime":{
            "type":"string",
            "format":"date-time",
            "description":"The last time that the system evaluated the collections amounts for the account.",
            "example":"2024-01-01T00:00:00-08:00"
        }
    }
}

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

Type: array

Show Source

Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "accountId":{
                "type":"object",
                "description":"The Account ID is a system-assigned random number that stays with an account for life.",
                "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"
                    },
                    "_link":{
                        "type":"string",
                        "description":"_link"
                    }
                }
            },
            "collectionsInitialDate":{
                "type":"string",
                "format":"date",
                "description":"The date that an active collections process started for the person.",
                "example":"2022-08-08"
            },
            "collectionsInitialAmount":{
                "type":"number",
                "description":"Initial amount in collections.",
                "example":"260.28"
            }
        }
    }
}

Nested Schema : recentPaymentDetails

Type: object

Show Source

accountId: object accountId

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

Payment Amount is the amount of the payment.

Example: 1
paymentDate: string (date)

Payment date

Example: 2021-06-08

{
    "type":"object",
    "properties":{
        "accountId":{
            "type":"object",
            "description":"The Account ID is a system-assigned random number that stays with an account for life.",
            "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"
                },
                "_link":{
                    "type":"string",
                    "description":"_link"
                }
            }
        },
        "paymentDate":{
            "type":"string",
            "format":"date",
            "description":"Payment date",
            "example":"2021-06-08"
        },
        "paymentAmount":{
            "type":"number",
            "description":"Payment Amount is the amount of the payment.",
            "example":"1"
        }
    }
}

Nested Schema : items

Type: object

Show Source

accountId: object accountId

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

Initial amount in collections.

Example: 260.28
collectionsInitialDate: string (date)

The date that an active collections process started for the person.

Example: 2022-08-08

{
    "type":"object",
    "properties":{
        "accountId":{
            "type":"object",
            "description":"The Account ID is a system-assigned random number that stays with an account for life.",
            "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"
                },
                "_link":{
                    "type":"string",
                    "description":"_link"
                }
            }
        },
        "collectionsInitialDate":{
            "type":"string",
            "format":"date",
            "description":"The date that an active collections process started for the person.",
            "example":"2022-08-08"
        },
        "collectionsInitialAmount":{
            "type":"number",
            "description":"Initial amount in collections.",
            "example":"260.28"
        }
    }
}

Nested Schema : accountId

Type: object

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

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

{
    "type":"object",
    "description":"The Account ID is a system-assigned random number that stays with an account for life.",
    "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"
        },
        "_link":{
            "type":"string",
            "description":"_link"
        }
    }
}

Nested Schema : accountId

Type: object

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

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

{
    "type":"object",
    "description":"The Account ID is a system-assigned random number that stays with an account for life.",
    "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"
        },
        "_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."
        }
    }
}