Search Bills
post
https://server:port/spl/rest/apis/customer/financials/bills/search
This operation retrieves bills information details for the provided input account id.
Request
There are no request parameters for this operation.
Supported Media Types
- application/xml
- application/json
Nested Schema : Filters
Type:
Show Source
object
-
accountSearch: object
accountSearch
-
endDate: string
(date)
Bill end date and it is an optional field which if left blank , gets defaulted to current date.
-
startDate: string
(date)
Bill start date and it is an optional field which if left blank , gets defaulted to 13 months prior to endDate.
Nested Schema : accountSearch
Type:
Show Source
object
-
accountId: string
Maximum Length:
10
Account ID identifies the customer who is responsible for the bill.Example:5499331599
-
serviceTypeBreakdown: string
Maximum Length:
1
Service Type breakdownExample:Y
Nested Schema : Filters
Type:
Show Source
object
-
accountSearch: object
accountSearch
-
endDate: string
(date)
Bill end date and it is an optional field which if left blank , gets defaulted to current date.
-
startDate: string
(date)
Bill start date and it is an optional field which if left blank , gets defaulted to 13 months prior to endDate.
Nested Schema : accountSearch
Type:
Show Source
object
-
accountId: string
Maximum Length:
10
Account ID identifies the customer who is responsible for the bill.Example:5499331599
-
serviceTypeBreakdown: string
Maximum Length:
1
Service Type breakdownExample:Y
Response
Supported Media Types
- application/xml
- application/json
200 Response
Success response
Root Schema : C1BillsForAc
Type:
Show Source
object
-
accountBalanceForward: string
Maximum Length:
8
Account Balance ForwardExample:Y
-
accountSetupDate: string
(date)
Bill Date is the business date used when the bill was completed.Example:
2001-05-01
-
bills: array
bills
-
currency: object
currency
Currency Code defines the currency in which the account's financial transactions are expressed.
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 : items
Type:
Show Source
object
-
beginningBalance: number
Beginning Balance is the balance from the account's last bill.Example:
70177.75
-
bill: object
bill
-
billDate: string
(date)
Bill Date is the business date used when the bill was completed.Example:
2001-05-01
-
billPeriodEndDate: string
(date)
Start Date - End Date is the portion of the bill segment period that the calculation details apply.
-
billPeriodStartDate: string
(date)
Start Date - End Date is the portion of the bill segment period that the calculation details apply.
-
endingBalance: number
Ending Balance For This Period is the amount owed by the customer as of the end of the bill period.Example:
103496.28
-
mixedPeriodIndicator: boolean
Mixed Period IndicatorExample:
false
-
serviceTypeCharges: array
serviceTypeCharges
-
totalAdjustmentAmount: number
Total Adjustments is the total amount of frozen or canceled adjustment financial transactions linked to this bill
-
totalChangesAfterCompletion: number
Total billing charges after completionExample:
0
-
totalCorrectionAmount: number
Total Bill Corrections is the total amount of canceled or rebilled bill segment financial transactions linked to this bill.
-
totalCurrentCharges: number
Total Current Billing Charges is the total amount of frozen bill segment financial transactions linked to this bill.Example:
50
-
totalPaymentAmount: number
Total Payments is the total amount of frozen or canceled payment segment financial transactions linked to this bill.Example:
0
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 : items
Type:
Show Source
object
-
chargeAmount: string
(date)
Calculated Amount
-
hasCancelled: boolean
If the bill has canceled bill segment financial transactionsExample:
true
-
hasRebilled: boolean
If the bill has rebilled bill segment financial transactionsExample:
true
-
mixedPeriodIndicator: boolean
Mixed Period IndicatorExample:
false
-
servicePeriodEndDate: string
(date)
Start Date - End Date is the portion of the bill segment period that the calculation details apply.
-
servicePeriodStartDate: string
(date)
Start Date - End Date is the portion of the bill segment period that the calculation details apply.
-
serviceType: string
Maximum Length:
30
Service TypeExample:E
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.