Bill Summary
get
https://server:port/spl/rest/apis/customer/financials/bills/{billId}/billSummary
This operation retrieves bill Summary details for the provided Bill Id.
Request
Path Parameters
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 : C1BillSumry
Type:
Show Source
object
-
_self: string
_self
-
account: object
account
-
balanceForwardValues: object
balanceForwardValues
-
bill: object
bill
-
billDate: string
(date)
Bill Date is the business date used when the bill was completed.Example:
2001-05-01
-
billedChargesCount: number
Minimum Value:
0
Maximum Value:99999
Billed Charges Count -
billedChargesSummary: array
billedChargesSummary
-
chargeTotals: object
chargeTotals
-
createDateTime: string
(date-time)
Create Date/Time is the date and time on which the bill was originally created.Example:
2002-10-24T16:51:58-04:00
-
currency: object
currency
Currency Code defines the currency in which the account's financial transactions are expressed.
-
dueDate: string
(date)
Due Date is the date on which the bill is due.Example:
2001-05-16
-
endPeriodDate: string
(date)
Start Date - End Date is the portion of the bill segment period that the calculation details apply.
-
fieldNameForBillTotals: string
Maximum Length:
60
Field Names for Bill totals -
fieldNameForBillTotals10: string
Maximum Length:
60
Field Names for Bill totals -
fieldNameForBillTotals2: string
Maximum Length:
60
Field Names for Bill totals -
fieldNameForBillTotals3: string
Maximum Length:
60
Field Names for Bill totals -
fieldNameForBillTotals4: string
Maximum Length:
60
Field Names for Bill totals -
fieldNameForBillTotals5: string
Maximum Length:
60
Field Names for Bill totals -
fieldNameForBillTotals6: string
Maximum Length:
60
Field Names for Bill totals -
fieldNameForBillTotals7: string
Maximum Length:
60
Field Names for Bill totals -
fieldNameForBillTotals8: string
Maximum Length:
60
Field Names for Bill totals -
fieldNameForBillTotals9: string
Maximum Length:
60
Field Names for Bill totals -
fieldValueForBillTotals: number
Field Value For bill totals
-
fieldValueForBillTotals10: number
Field Value For bill totals
-
fieldValueForBillTotals2: number
Field Value For bill totals
-
fieldValueForBillTotals3: number
Field Value For bill totals
-
fieldValueForBillTotals4: number
Field Value For bill totals
-
fieldValueForBillTotals5: number
Field Value For bill totals
-
fieldValueForBillTotals6: number
Field Value For bill totals
-
fieldValueForBillTotals7: number
Field Value For bill totals
-
fieldValueForBillTotals8: number
Field Value For bill totals
-
fieldValueForBillTotals9: number
Field Value For bill totals
-
isBalanceForward: boolean
Open Item accounting
-
lateChargeDate: string
(date)
Late Payment Charge Date is the date on which the system will levy a late payment charge if payment is not received.Example:
2001-05-21
-
mixedPeriodIndicator: boolean
Mixed Period IndicatorExample:
false
-
openItemValues: object
openItemValues
-
startPeriodDate: string
(date)
Start Date - End Date is the portion of the bill segment period that the calculation details apply.
-
status: string
Allowed Values:
[ "C ", "P " ]
Bill Status is the bill's status. A bill is initially saved in the Pending state. One or more bill segments can be created for the account's service agreements at this point. A bill becomes Complete when it is ready to be sent to the customer. * `C ` - Complete, * `P ` - PendingExample:C
-
statusDescription: string
Allowed Values:
[ "C ", "P " ]
Description about Bill Segment status. * `C ` - Complete, * `P ` - Pending
Nested Schema : account
Type:
Show Source
object
-
_link: string
_link
-
accountId: string
Maximum Length:
10
Account ID identifies the customer who is responsible for the bill.Example:5499331599
Nested Schema : balanceForwardValues
Type:
Show Source
object
-
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
-
previousBalance: number
Beginning Balance is the balance from the account's last bill.Example:
70177.75
-
totalPayments: 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 : chargeTotals
Type:
Show Source
object
-
corrections: number
Total Bill Corrections is the total amount of canceled or rebilled bill segment financial transactions linked to this billExample:
0
-
currentCharges: number
Total Current Billing Charges is the total amount of frozen bill segment financial transactions linked to this bill.Example:
0
-
otherCharges: number
Total Adjustments is the total amount of frozen or canceled adjustment financial transactions linked to this bill.Example:
0
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 : openItemValues
Type:
Show Source
object
-
balancedAmount: number
Balanced Amount contains the total amount of financial transactions linked to this bill that are linked to balanced match events.Example:
0
-
disputedAmount: number
Disputed Amount contains the total amount of financial transactions linked to this bill that are linked to disputed match events.Example:
0
-
numberOfBalancedItems: number
Minimum Value:
0
Maximum Value:999999
Number of Balanced Items contains the count of financial transactions linked to this bill that are linked to balanced match events.Example:0
-
numberOfDisputedItems: number
Minimum Value:
0
Maximum Value:999999
Number of Disputed Items contains the count of financial transactions linked to this bill that are linked to disputed match events.Example:0
-
numberOfUnbalancedItems: number
Minimum Value:
0
Maximum Value:999999
Number of Unbalanced Items contains the count of financial transactions linked to this bill that are linked to unbalanced match events.Example:0
-
numberOfUnmatchedItems: number
Minimum Value:
0
Maximum Value:999999
Number of Unmatched Items contains the count of financial transactions linked to this bill that are not linked to any match event.Example:0
-
unbalancedAmount: number
Unbalanced Amount contains total amount of financial transactions linked to this bill that are linked to unbalanced match events.Example:
0
-
unmatchedAmount: number
Unmatched Amount contains the total amount of financial transactions linked to this bill that are not linked to any match event.Example:
0
Nested Schema : items
Type:
Show Source
object
-
billSegmentStatus: string
Allowed Values:
[ "10 ", "20 ", "30 ", "40 ", "50 ", "60 ", "70 " ]
Status is the bill segment's status. * `10 ` - Incomplete, * `20 ` - Error, * `30 ` - Freezable, * `40 ` - Pending Cancel, * `50 ` - Frozen, * `60 ` - Canceled, * `70 ` - OKExample:50
-
billSegmentStatusDescription: string
Maximum Length:
60
Description on Bill is the information about the bill line that appears on the customer's bill. -
count: number
Minimum Value:
0
Maximum Value:99999
Count -
hasEstimates: boolean
Estimate
-
serviceTypeSummary: array
serviceTypeSummary
-
totalAmount: number
Payoff Amount
Nested Schema : items
Type:
Show Source
object
-
count: number
Minimum Value:
0
Maximum Value:99999
Count -
serviceType: string
Maximum Length:
30
Service TypeExample:E
-
totalAmount: number
Calculated Amount
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.