Get Account Collection Details
get
/rest/apis/customer/financials/accountData/{accountId}/collectionDetails
Request
Path Parameters
-
accountId(required): string
The Account ID is a system-assigned random number that stays with an account for life.Example:
1589800000
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/xml
- application/json
200 Response
Success response
Root Schema : C1AcctCollDe
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
Name -
collectionsActive: boolean
When defined as true, indicates that there are active collections or overdue processes on the account.Example:
false
-
collectionsAmounts: object
collectionsAmounts
-
collectionsEntities: array
collectionsEntities
-
collectionsInitialAmount: number
Initial Collection Amount from the Collection Process or Overdue Process.
-
collectionsInitialDate: string
(date)
Initial Collection Date if there are active Severance Processes.
-
creditRating: number
Minimum Value:
-99999
Maximum Value:99999
A Credit Rating is an evaluation of the credit risk of a customer based on their payment history. An account's Credit Rating is equal to the start credit rating value defined on the system installation plus the sum of credit rating demerits that are currently in effect.Example:800
-
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)
Calculation Datetime
-
collectionsMinimumAmount: number
Collection Minimum Amount for the account.Example:
20
-
collectionsTotalAmount: number
Collection Total Amount for the account.Example:
30
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
When defined as true, indicates that the account is disconnected.Example:
true
-
disconnectStartDate: string
(date)
The disconnect start date for an account. A blank date indicates that the account is not scheduled for or has completed a disconnection.Example:
2022-11-04
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
-
entityType: string
Maximum Length:
4
Object reference to the type of collection record that is active such as 'COLL PROC', 'SEV PROC', 'C1-OD-PROC'.Example:COLL PROC
-
pkValue1: string
Maximum Length:
254
Primary Key Value 1 as a unique identifier of the object record indicated by the entity type.Example:0275450563
Nested Schema : items
Type:
Show Source
object
-
scheduledPaymentAmount: number
Scheduled Payment Amount
-
scheduledPaymentDate: string
(date)
Scheduled to Pay
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.