Account Financial Statistics
post
https://server:port/spl/rest/apis/customer/financials/accountData/{accountId}/financialStatistics
This operation provides various summary calculations and provide statistical data for a billing account for a given date range.
Request
Path Parameters
-
accountId(required): string
The Account ID is a system-assigned random number that stays with an account for life.Example:
1589800000
Supported Media Types
- application/xml
- application/json
Root Schema : schema
Type:
Show Source
object
-
endDate: string
(date)
End DateExample:
2001-08-01
-
httpMethod: string
Allowed Values:
[ "DELT", "GET ", "POST", "PTCH", "PUT " ]
HTTP MethodExample:GET
-
startDate: string
(date)
Start DateExample:
2001-01-01
Root Schema : schema
Type:
Show Source
object
-
endDate: string
(date)
End DateExample:
2001-08-01
-
httpMethod: string
Allowed Values:
[ "DELT", "GET ", "POST", "PTCH", "PUT " ]
HTTP MethodExample:GET
-
startDate: string
(date)
Start DateExample:
2001-01-01
Response
Supported Media Types
- application/xml
- application/json
200 Response
Success response
Root Schema : C1FinStats
Type:
Show Source
object
-
account: object
account
-
accountSetupDate: string
(date)
Account Setup DateExample:
2001-01-01
-
billing: object
billing
-
currency: object
currency
Currency Code defines the currency in which the account's financial transactions are expressed.
-
httpMethod: string
Allowed Values:
[ "DELT", "GET ", "POST", "PTCH", "PUT " ]
HTTP MethodExample:GET
-
payments: object
payments
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 : billing
Type:
Show Source
object
-
earliestBillDate: string
(date)
Earliest of the bill datesExample:
2001-01-01
-
latestBillDate: string
(date)
Latest of the bill datesExample:
2001-07-01
-
totalBilledAmount: number
Total Billed AmountExample:
1562.02
-
totalNumberBills: number
Minimum Value:
0
Maximum Value:99999
Total number of BillsExample:7
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 : payments
Type:
Show Source
object
-
totalNumberOnTimePayments: number
Minimum Value:
0
Maximum Value:99999
Total number of On- Time PaymentsExample:7
-
totalNumberPayments: number
Minimum Value:
0
Maximum Value:99999
Total number Of PaymentsExample:7
-
totalPaymentAmount: number
Total Payment AmountExample:
1562.02
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.