Person Accounts Collection Details
get
/rest/apis/customer/financials/personData/{personId}/collectionDebtList
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
Query Parameters
-
limit: number
Limit is an integer value that specifies the paging size for number of records to return when serving a client request.Example:
100
-
offset: number
The offset element is an integer value that specifies the index of the first item to be returned. The offset index begins at 0 and cannot be negative.Example:
0
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/xml
- application/json
200 Response
Success response
Root Schema : C1PerColl
Type:
Show Source
object
-
accounts: array
accounts
-
collectionsBillingAccountsCount: number
Minimum Value:
0
Maximum Value:99999
Number of accounts that are in collections.Example:1
-
limit: number
Minimum Value:
0
Maximum Value:999999999.999999
Limit is an integer value that specifies the paging size for number of records to return when serving a client request.Example:100
-
offset: number
Minimum Value:
0
Maximum Value:999999999.999999
The offset element is an integer value that specifies the index of the first item to be returned. The offset index begins at 0 and cannot be negative.Example:0
-
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
Nested Schema : items
Type:
Show Source
object
-
accountId: object
accountId
The Account ID is a system-assigned random number that stays with an account for life.
-
accountName: string
Maximum Length:
254
A descriptive name for the billing account.Example:Main Office
-
collectionsAmounts: object
collectionsAmounts
-
currency: object
currency
Currency Code defines the currency in which the account's financial transactions are expressed.
-
disconnectInformation: object
disconnectInformation
-
lastPayment: object
lastPayment
-
scheduledPayments: array
scheduledPayments
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
Nested Schema : collectionsAmounts
Type:
Show Source
object
-
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
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
Nested Schema : disconnectInformation
Type:
Show Source
object
-
disconnectActive: boolean
Boolean that is true if any severance/cut process is active.Example:
true
-
disconnectStartDate: string
(date)
Date of initiation of the earliest active severance/cut process for the account, or if in collections, the date of the event to start severance/cut.Example:
2023-02-08
Nested Schema : lastPayment
Type:
Show Source
object
-
paymentAmount: number
Payment Amount is the amount of the payment.Example:
1
-
paymentDate: string
(date)
Payment dateExample:
2021-06-08
Nested Schema : items
Type:
Show Source
object
-
scheduledPaymentAmount: number
Amount of scheduled payment.
-
scheduledPaymentDate: string
(date)
Date of scheduled payment.
400 Response
Bad Request
Root Schema : problemDetailDocument
Type:
Show Source
object
-
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.
Nested Schema : serverMessage
Type:
Show Source
object
-
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.
500 Response
Internal Server Error
Root Schema : problemDetailDocument
Type:
Show Source
object
-
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.
Nested Schema : serverMessage
Type:
Show Source
object
-
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.