Get Account Financial Details
get
https://server:port/spl/rest/apis/customer/financials/accountData/{accountId}/financialDetails
This operation retrieves the financial details for the provided Account Id.
Request
Path Parameters
-
accountId(required): string
The Account ID is a system-assigned random number that stays with an account for life.Example:
1589800000
Query Parameters
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/xml
- application/json
200 Response
Success response
Root Schema : C1FinDetails
Type:
Show Source
object
-
_self: string
_self
-
account: object
account
-
arrearsDetails: object
arrearsDetails
-
autoPaySourceCode: string
Maximum Length:
12
Auto Pay Source is used to define the source of the funds, such as a banking institution, used to satisfy the automatic payment request.Example:AMEX
-
autoPaySourceDescr: string
Maximum Length:
60
Auto Pay Source Description defines the source of the funds, such as a banking institution, used to satisfy the automatic payment request. -
billedAmountYTD: number
Billed Amount Year-to-dateExample:
600.25
-
currency: object
currency
Currency Code defines the currency in which the account's financial transactions are expressed.
-
currentBalance: number
Current Balance shows the account's current balance after the financial event.Example:
48337.45
-
currentCreditRating: number
Minimum Value:
0
Maximum Value:0
Current Credit RatingExample:800
-
depositAmount: number
Amount of the non-cash depositExample:
0
-
httpMethod: string
Allowed Values:
[ "DELT", "GET ", "POST", "PTCH", "PUT " ]
HTTP MethodExample:GET
-
lastBill: object
lastBill
-
lastPayment: object
lastPayment
-
nextBillDate: string
(date)
Bill Date
-
nextCreditReviewDate: string
(date)
The next date on which the account's debt will be reviewed by the account debt monitor process.Example:
2022-05-11
-
onTimePaymentsLast12Months: number
Minimum Value:
0
Maximum Value:1.0E30
On-Time payment Last 12 monthsExample:43%
-
payoffBalance: number
Payoff Balance shows the account's payoff balance after the financial event.Example:
48337.45
Nested Schema : account
Type:
Show Source
object
-
_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 : 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 : lastBill
Type:
Show Source
object
-
bill: object
bill
-
billAmount: number
Current Charges
-
billDate: string
(date)
Bill Date
-
billDueDate: string
(date)
Due Date is the date on which the bill is due.Example:
1999-10-11
Nested Schema : lastPayment
Type:
Show Source
object
-
payment: object
payment
-
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
-
arrearsAmount: number
The Days Aged and Arrears Amount information shows how old the current balance is.Example:
2062.26
-
dayAge: number
Minimum Value:
-99999
Maximum Value:99999
The Days Aged and Arrears Amount information shows how old the current balance is.Example:8558
Nested Schema : bill
Type:
Show Source
object
-
_link: string
_link
-
billId: string
Maximum Length:
12
Bill ID is the system-assigned unique identifier of the bill.Example:549133128888
Nested Schema : payment
Type:
Show Source
object
-
_link: string
_link
-
paymentId: string
Maximum Length:
12
Payment ID is the system-assigned, unique identifier of the payment to which the financial transaction is linked.Example:025898353555
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.