Oracle Utilities REST API for Metering and Customer Information

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

billId(required): string

Query Parameters

serviceTypeBreakdown: string

There's no request body for this operation.

Response

Supported Media Types

application/xml
application/json

200 Response

Success response

Root Schema : C1BillSumry

Type: object

Show Source

_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 Indicator

Example: 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 ` - Pending

Example: C
statusDescription: string

Allowed Values: [ "C ", "P " ]

Description about Bill Segment status. * `C ` - Complete, * `P ` - Pending

{
    "type":"object",
    "properties":{
        "_self":{
            "type":"string",
            "description":"_self"
        },
        "bill":{
            "type":"object",
            "properties":{
                "_link":{
                    "type":"string",
                    "description":"_link"
                },
                "billId":{
                    "type":"string",
                    "maxLength":12,
                    "description":"Bill ID is the system-assigned unique identifier of the bill.",
                    "example":"549133128888"
                }
            }
        },
        "account":{
            "type":"object",
            "properties":{
                "_link":{
                    "type":"string",
                    "description":"_link"
                },
                "accountId":{
                    "type":"string",
                    "maxLength":10,
                    "description":"Account ID identifies the customer who is responsible for the bill.",
                    "example":"5499331599"
                }
            }
        },
        "status":{
            "type":"string",
            "enum":[
                "C   ",
                "P   "
            ],
            "description":"Bill Status is the bill's status.\n\nA 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.\n\nA bill becomes Complete when it is ready to be sent to the customer.\n* `C   ` - Complete,\n* `P   ` - Pending",
            "example":"C"
        },
        "statusDescription":{
            "type":"string",
            "enum":[
                "C   ",
                "P   "
            ],
            "description":"Description about Bill Segment status.\n* `C   ` - Complete,\n* `P   ` - Pending"
        },
        "createDateTime":{
            "type":"string",
            "format":"date-time",
            "description":"Create Date/Time is the date and time on which the bill was originally created.",
            "example":"2002-10-24T16:51:58-04:00"
        },
        "billDate":{
            "type":"string",
            "format":"date",
            "description":"Bill Date is the business date used when the bill was completed.",
            "example":"2001-05-01"
        },
        "dueDate":{
            "type":"string",
            "format":"date",
            "description":"Due Date is the date on which the bill is due.",
            "example":"2001-05-16"
        },
        "lateChargeDate":{
            "type":"string",
            "format":"date",
            "description":"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"
        },
        "currency":{
            "type":"object",
            "description":"Currency Code defines the currency in which the account's financial transactions are expressed.",
            "properties":{
                "_link":{
                    "type":"string",
                    "description":"_link"
                },
                "currency":{
                    "type":"string",
                    "maxLength":3,
                    "description":"Currency Code defines the currency in which the account's financial transactions are expressed.",
                    "example":"USD"
                }
            }
        },
        "isBalanceForward":{
            "type":"boolean",
            "description":"Open Item accounting"
        },
        "chargeTotals":{
            "type":"object",
            "properties":{
                "currentCharges":{
                    "type":"number",
                    "description":"Total Current Billing Charges is the total amount of frozen bill segment financial transactions linked to this bill.",
                    "example":"0"
                },
                "otherCharges":{
                    "type":"number",
                    "description":"Total Adjustments is the total amount of frozen or canceled adjustment financial transactions linked to this bill.",
                    "example":"0"
                },
                "corrections":{
                    "type":"number",
                    "description":"Total Bill Corrections is the total amount of canceled or rebilled bill segment financial transactions linked to this bill",
                    "example":"0"
                }
            }
        },
        "balanceForwardValues":{
            "type":"object",
            "properties":{
                "previousBalance":{
                    "type":"number",
                    "description":"Beginning Balance is the balance from the account's last bill.",
                    "example":"70177.75"
                },
                "totalPayments":{
                    "type":"number",
                    "description":"Total Payments is the total amount of frozen or canceled payment segment financial transactions linked to this bill.",
                    "example":"0"
                },
                "endingBalance":{
                    "type":"number",
                    "description":"Ending Balance For This Period is the amount owed by the customer as of the end of the bill period.",
                    "example":"103496.28"
                }
            }
        },
        "openItemValues":{
            "type":"object",
            "properties":{
                "numberOfBalancedItems":{
                    "type":"number",
                    "maximum":999999,
                    "minimum":0,
                    "description":"Number of Balanced Items contains the count of financial transactions linked to this bill that are linked to balanced match events.",
                    "example":"0"
                },
                "balancedAmount":{
                    "type":"number",
                    "description":"Balanced Amount contains the total amount of financial transactions linked to this bill that are linked to balanced match events.",
                    "example":"0"
                },
                "numberOfUnbalancedItems":{
                    "type":"number",
                    "maximum":999999,
                    "minimum":0,
                    "description":"Number of Unbalanced Items contains the count of financial transactions linked to this bill that are linked to unbalanced match events.",
                    "example":"0"
                },
                "unbalancedAmount":{
                    "type":"number",
                    "description":"Unbalanced Amount contains total amount of financial transactions linked to this bill that are linked to unbalanced match events.",
                    "example":"0"
                },
                "numberOfDisputedItems":{
                    "type":"number",
                    "maximum":999999,
                    "minimum":0,
                    "description":"Number of Disputed Items contains the count of financial transactions linked to this bill that are linked to disputed match events.",
                    "example":"0"
                },
                "disputedAmount":{
                    "type":"number",
                    "description":"Disputed  Amount contains the total amount of financial transactions linked to this bill that are linked to disputed match events.",
                    "example":"0"
                },
                "numberOfUnmatchedItems":{
                    "type":"number",
                    "maximum":999999,
                    "minimum":0,
                    "description":"Number of Unmatched Items contains the count of financial transactions linked to this bill that are not linked to any match event.",
                    "example":"0"
                },
                "unmatchedAmount":{
                    "type":"number",
                    "description":"Unmatched Amount contains the total amount of financial transactions linked to this bill that are not linked to any match event.",
                    "example":"0"
                }
            }
        },
        "fieldNameForBillTotals":{
            "type":"string",
            "maxLength":60,
            "description":"Field Names for Bill totals"
        },
        "fieldValueForBillTotals":{
            "type":"number",
            "description":"Field Value For bill totals"
        },
        "fieldNameForBillTotals2":{
            "type":"string",
            "maxLength":60,
            "description":"Field Names for Bill totals"
        },
        "fieldValueForBillTotals2":{
            "type":"number",
            "description":"Field Value For bill totals"
        },
        "fieldNameForBillTotals3":{
            "type":"string",
            "maxLength":60,
            "description":"Field Names for Bill totals"
        },
        "fieldValueForBillTotals3":{
            "type":"number",
            "description":"Field Value For bill totals"
        },
        "fieldNameForBillTotals4":{
            "type":"string",
            "maxLength":60,
            "description":"Field Names for Bill totals"
        },
        "fieldValueForBillTotals4":{
            "type":"number",
            "description":"Field Value For bill totals"
        },
        "fieldNameForBillTotals5":{
            "type":"string",
            "maxLength":60,
            "description":"Field Names for Bill totals"
        },
        "fieldValueForBillTotals5":{
            "type":"number",
            "description":"Field Value For bill totals"
        },
        "fieldNameForBillTotals6":{
            "type":"string",
            "maxLength":60,
            "description":"Field Names for Bill totals"
        },
        "fieldValueForBillTotals6":{
            "type":"number",
            "description":"Field Value For bill totals"
        },
        "fieldNameForBillTotals7":{
            "type":"string",
            "maxLength":60,
            "description":"Field Names for Bill totals"
        },
        "fieldValueForBillTotals7":{
            "type":"number",
            "description":"Field Value For bill totals"
        },
        "fieldNameForBillTotals8":{
            "type":"string",
            "maxLength":60,
            "description":"Field Names for Bill totals"
        },
        "fieldValueForBillTotals8":{
            "type":"number",
            "description":"Field Value For bill totals"
        },
        "fieldNameForBillTotals9":{
            "type":"string",
            "maxLength":60,
            "description":"Field Names for Bill totals"
        },
        "fieldValueForBillTotals9":{
            "type":"number",
            "description":"Field Value For bill totals"
        },
        "fieldNameForBillTotals10":{
            "type":"string",
            "maxLength":60,
            "description":"Field Names for Bill totals"
        },
        "fieldValueForBillTotals10":{
            "type":"number",
            "description":"Field Value For bill totals"
        },
        "startPeriodDate":{
            "type":"string",
            "format":"date",
            "description":"Start Date - End Date is the portion of the bill segment period that the calculation details apply."
        },
        "endPeriodDate":{
            "type":"string",
            "format":"date",
            "description":"Start Date - End Date is the portion of the bill segment period that the calculation details apply."
        },
        "mixedPeriodIndicator":{
            "type":"boolean",
            "description":"Mixed Period Indicator",
            "example":"false"
        },
        "billedChargesCount":{
            "type":"number",
            "maximum":99999,
            "minimum":0,
            "description":"Billed Charges Count"
        },
        "billedChargesSummary":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "billSegmentStatus":{
                        "type":"string",
                        "enum":[
                            "10  ",
                            "20  ",
                            "30  ",
                            "40  ",
                            "50  ",
                            "60  ",
                            "70  "
                        ],
                        "description":"Status is the bill segment's status.\n* `10  ` - Incomplete,\n* `20  ` - Error,\n* `30  ` - Freezable,\n* `40  ` - Pending Cancel,\n* `50  ` - Frozen,\n* `60  ` - Canceled,\n* `70  ` - OK",
                        "example":"50"
                    },
                    "billSegmentStatusDescription":{
                        "type":"string",
                        "maxLength":60,
                        "description":"Description on Bill is the information about the bill line that appears on the customer's bill."
                    },
                    "totalAmount":{
                        "type":"number",
                        "description":"Payoff Amount"
                    },
                    "count":{
                        "type":"number",
                        "maximum":99999,
                        "minimum":0,
                        "description":"Count"
                    },
                    "hasEstimates":{
                        "type":"boolean",
                        "description":"Estimate"
                    },
                    "serviceTypeSummary":{
                        "type":"array",
                        "items":{
                            "type":"object",
                            "properties":{
                                "serviceType":{
                                    "type":"string",
                                    "maxLength":30,
                                    "description":"Service Type",
                                    "example":"E"
                                },
                                "totalAmount":{
                                    "type":"number",
                                    "description":"Calculated Amount"
                                },
                                "count":{
                                    "type":"number",
                                    "maximum":99999,
                                    "minimum":0,
                                    "description":"Count"
                                }
                            }
                        }
                    }
                }
            }
        }
    },
    "xml":{
        "name":"C1BillSumry"
    }
}

Nested Schema : account

Type: object

Show Source

_link: string

_link
accountId: string

Maximum Length: 10

Account ID identifies the customer who is responsible for the bill.

Example: 5499331599

{
    "type":"object",
    "properties":{
        "_link":{
            "type":"string",
            "description":"_link"
        },
        "accountId":{
            "type":"string",
            "maxLength":10,
            "description":"Account ID identifies the customer who is responsible for the bill.",
            "example":"5499331599"
        }
    }
}

Nested Schema : balanceForwardValues

Type: object

Show Source

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

{
    "type":"object",
    "properties":{
        "previousBalance":{
            "type":"number",
            "description":"Beginning Balance is the balance from the account's last bill.",
            "example":"70177.75"
        },
        "totalPayments":{
            "type":"number",
            "description":"Total Payments is the total amount of frozen or canceled payment segment financial transactions linked to this bill.",
            "example":"0"
        },
        "endingBalance":{
            "type":"number",
            "description":"Ending Balance For This Period is the amount owed by the customer as of the end of the bill period.",
            "example":"103496.28"
        }
    }
}

Nested Schema : bill

Type: object

Show Source

_link: string

_link
billId: string

Maximum Length: 12

Bill ID is the system-assigned unique identifier of the bill.

Example: 549133128888

{
    "type":"object",
    "properties":{
        "_link":{
            "type":"string",
            "description":"_link"
        },
        "billId":{
            "type":"string",
            "maxLength":12,
            "description":"Bill ID is the system-assigned unique identifier of the bill.",
            "example":"549133128888"
        }
    }
}

Nested Schema : billedChargesSummary

Type: array

Show Source

Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "billSegmentStatus":{
                "type":"string",
                "enum":[
                    "10  ",
                    "20  ",
                    "30  ",
                    "40  ",
                    "50  ",
                    "60  ",
                    "70  "
                ],
                "description":"Status is the bill segment's status.\n* `10  ` - Incomplete,\n* `20  ` - Error,\n* `30  ` - Freezable,\n* `40  ` - Pending Cancel,\n* `50  ` - Frozen,\n* `60  ` - Canceled,\n* `70  ` - OK",
                "example":"50"
            },
            "billSegmentStatusDescription":{
                "type":"string",
                "maxLength":60,
                "description":"Description on Bill is the information about the bill line that appears on the customer's bill."
            },
            "totalAmount":{
                "type":"number",
                "description":"Payoff Amount"
            },
            "count":{
                "type":"number",
                "maximum":99999,
                "minimum":0,
                "description":"Count"
            },
            "hasEstimates":{
                "type":"boolean",
                "description":"Estimate"
            },
            "serviceTypeSummary":{
                "type":"array",
                "items":{
                    "type":"object",
                    "properties":{
                        "serviceType":{
                            "type":"string",
                            "maxLength":30,
                            "description":"Service Type",
                            "example":"E"
                        },
                        "totalAmount":{
                            "type":"number",
                            "description":"Calculated Amount"
                        },
                        "count":{
                            "type":"number",
                            "maximum":99999,
                            "minimum":0,
                            "description":"Count"
                        }
                    }
                }
            }
        }
    }
}

Nested Schema : chargeTotals

Type: object

Show Source

corrections: number

Total Bill Corrections is the total amount of canceled or rebilled bill segment financial transactions linked to this bill

Example: 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

{
    "type":"object",
    "properties":{
        "currentCharges":{
            "type":"number",
            "description":"Total Current Billing Charges is the total amount of frozen bill segment financial transactions linked to this bill.",
            "example":"0"
        },
        "otherCharges":{
            "type":"number",
            "description":"Total Adjustments is the total amount of frozen or canceled adjustment financial transactions linked to this bill.",
            "example":"0"
        },
        "corrections":{
            "type":"number",
            "description":"Total Bill Corrections is the total amount of canceled or rebilled bill segment 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

{
    "type":"object",
    "description":"Currency Code defines the currency in which the account's financial transactions are expressed.",
    "properties":{
        "_link":{
            "type":"string",
            "description":"_link"
        },
        "currency":{
            "type":"string",
            "maxLength":3,
            "description":"Currency Code defines the currency in which the account's financial transactions are expressed.",
            "example":"USD"
        }
    }
}

Nested Schema : openItemValues

Type: object

Show Source

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

{
    "type":"object",
    "properties":{
        "numberOfBalancedItems":{
            "type":"number",
            "maximum":999999,
            "minimum":0,
            "description":"Number of Balanced Items contains the count of financial transactions linked to this bill that are linked to balanced match events.",
            "example":"0"
        },
        "balancedAmount":{
            "type":"number",
            "description":"Balanced Amount contains the total amount of financial transactions linked to this bill that are linked to balanced match events.",
            "example":"0"
        },
        "numberOfUnbalancedItems":{
            "type":"number",
            "maximum":999999,
            "minimum":0,
            "description":"Number of Unbalanced Items contains the count of financial transactions linked to this bill that are linked to unbalanced match events.",
            "example":"0"
        },
        "unbalancedAmount":{
            "type":"number",
            "description":"Unbalanced Amount contains total amount of financial transactions linked to this bill that are linked to unbalanced match events.",
            "example":"0"
        },
        "numberOfDisputedItems":{
            "type":"number",
            "maximum":999999,
            "minimum":0,
            "description":"Number of Disputed Items contains the count of financial transactions linked to this bill that are linked to disputed match events.",
            "example":"0"
        },
        "disputedAmount":{
            "type":"number",
            "description":"Disputed  Amount contains the total amount of financial transactions linked to this bill that are linked to disputed match events.",
            "example":"0"
        },
        "numberOfUnmatchedItems":{
            "type":"number",
            "maximum":999999,
            "minimum":0,
            "description":"Number of Unmatched Items contains the count of financial transactions linked to this bill that are not linked to any match event.",
            "example":"0"
        },
        "unmatchedAmount":{
            "type":"number",
            "description":"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: object

Show Source

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 ` - OK

Example: 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

{
    "type":"object",
    "properties":{
        "billSegmentStatus":{
            "type":"string",
            "enum":[
                "10  ",
                "20  ",
                "30  ",
                "40  ",
                "50  ",
                "60  ",
                "70  "
            ],
            "description":"Status is the bill segment's status.\n* `10  ` - Incomplete,\n* `20  ` - Error,\n* `30  ` - Freezable,\n* `40  ` - Pending Cancel,\n* `50  ` - Frozen,\n* `60  ` - Canceled,\n* `70  ` - OK",
            "example":"50"
        },
        "billSegmentStatusDescription":{
            "type":"string",
            "maxLength":60,
            "description":"Description on Bill is the information about the bill line that appears on the customer's bill."
        },
        "totalAmount":{
            "type":"number",
            "description":"Payoff Amount"
        },
        "count":{
            "type":"number",
            "maximum":99999,
            "minimum":0,
            "description":"Count"
        },
        "hasEstimates":{
            "type":"boolean",
            "description":"Estimate"
        },
        "serviceTypeSummary":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "serviceType":{
                        "type":"string",
                        "maxLength":30,
                        "description":"Service Type",
                        "example":"E"
                    },
                    "totalAmount":{
                        "type":"number",
                        "description":"Calculated Amount"
                    },
                    "count":{
                        "type":"number",
                        "maximum":99999,
                        "minimum":0,
                        "description":"Count"
                    }
                }
            }
        }
    }
}

Nested Schema : serviceTypeSummary

Type: array

Show Source

Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "serviceType":{
                "type":"string",
                "maxLength":30,
                "description":"Service Type",
                "example":"E"
            },
            "totalAmount":{
                "type":"number",
                "description":"Calculated Amount"
            },
            "count":{
                "type":"number",
                "maximum":99999,
                "minimum":0,
                "description":"Count"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

count: number

Minimum Value: 0

Maximum Value: 99999

Count
serviceType: string

Maximum Length: 30

Service Type

Example: E
totalAmount: number

Calculated Amount

{
    "type":"object",
    "properties":{
        "serviceType":{
            "type":"string",
            "maxLength":30,
            "description":"Service Type",
            "example":"E"
        },
        "totalAmount":{
            "type":"number",
            "description":"Calculated Amount"
        },
        "count":{
            "type":"number",
            "maximum":99999,
            "minimum":0,
            "description":"Count"
        }
    }
}

400 Response

Bad Request

Root Schema : problemDetailDocument

Type: object

Show Source

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.

{
    "type":"object",
    "properties":{
        "problemType":{
            "type":"string",
            "maxLength":60,
            "description":"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."
        },
        "title":{
            "type":"string",
            "maxLength":60,
            "description":"Fully qualified error message from Oracle Utilities Application Framework in CDATA format."
        },
        "httpStatus":{
            "type":"number",
            "maximum":9999,
            "minimum":0,
            "description":"The HTTP Status code for the error."
        },
        "detail":{
            "type":"string",
            "maxLength":60,
            "description":"The long message description from the Oracle Utilities Application Framework in CDATA format."
        },
        "problemInstance":{
            "type":"string",
            "maxLength":60,
            "description":"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."
        },
        "stackTrace":{
            "type":"string",
            "maxLength":60,
            "description":"The stack trace shows where the error occurs during the execution of a program."
        },
        "serverMessage":{
            "type":"object",
            "properties":{
                "messageCategory":{
                    "type":"number",
                    "maximum":0,
                    "minimum":0,
                    "description":"Message Category within Oracle Utilities Application Framework."
                },
                "messageNbr":{
                    "type":"number",
                    "maximum":99999,
                    "minimum":-99999,
                    "description":"Message Number within Oracle Utilities Application Framework."
                },
                "callSequence":{
                    "type":"string",
                    "maxLength":60,
                    "description":"Delimited sequence of programs called."
                },
                "programName":{
                    "type":"string",
                    "maxLength":60,
                    "description":"Name of the program that encountered the error."
                },
                "messageText":{
                    "type":"string",
                    "maxLength":60,
                    "description":"Fully qualified error message from Oracle Utilities Application Framework in CDATA format."
                },
                "longDescription":{
                    "type":"string",
                    "maxLength":60,
                    "description":"The long message description from the Oracle Utilities Application Framework in CDATA format."
                }
            }
        }
    }
}

Nested Schema : serverMessage

Type: object

Show Source

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.

{
    "type":"object",
    "properties":{
        "messageCategory":{
            "type":"number",
            "maximum":0,
            "minimum":0,
            "description":"Message Category within Oracle Utilities Application Framework."
        },
        "messageNbr":{
            "type":"number",
            "maximum":99999,
            "minimum":-99999,
            "description":"Message Number within Oracle Utilities Application Framework."
        },
        "callSequence":{
            "type":"string",
            "maxLength":60,
            "description":"Delimited sequence of programs called."
        },
        "programName":{
            "type":"string",
            "maxLength":60,
            "description":"Name of the program that encountered the error."
        },
        "messageText":{
            "type":"string",
            "maxLength":60,
            "description":"Fully qualified error message from Oracle Utilities Application Framework in CDATA format."
        },
        "longDescription":{
            "type":"string",
            "maxLength":60,
            "description":"The long message description from the Oracle Utilities Application Framework in CDATA format."
        }
    }
}

500 Response

Internal Server Error

Root Schema : problemDetailDocument

Type: object

Show Source

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.

{
    "type":"object",
    "properties":{
        "problemType":{
            "type":"string",
            "maxLength":60,
            "description":"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."
        },
        "title":{
            "type":"string",
            "maxLength":60,
            "description":"Fully qualified error message from Oracle Utilities Application Framework in CDATA format."
        },
        "httpStatus":{
            "type":"number",
            "maximum":9999,
            "minimum":0,
            "description":"The HTTP Status code for the error."
        },
        "detail":{
            "type":"string",
            "maxLength":60,
            "description":"The long message description from the Oracle Utilities Application Framework in CDATA format."
        },
        "problemInstance":{
            "type":"string",
            "maxLength":60,
            "description":"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."
        },
        "stackTrace":{
            "type":"string",
            "maxLength":60,
            "description":"The stack trace shows where the error occurs during the execution of a program."
        },
        "serverMessage":{
            "type":"object",
            "properties":{
                "messageCategory":{
                    "type":"number",
                    "maximum":0,
                    "minimum":0,
                    "description":"Message Category within Oracle Utilities Application Framework."
                },
                "messageNbr":{
                    "type":"number",
                    "maximum":99999,
                    "minimum":-99999,
                    "description":"Message Number within Oracle Utilities Application Framework."
                },
                "callSequence":{
                    "type":"string",
                    "maxLength":60,
                    "description":"Delimited sequence of programs called."
                },
                "programName":{
                    "type":"string",
                    "maxLength":60,
                    "description":"Name of the program that encountered the error."
                },
                "messageText":{
                    "type":"string",
                    "maxLength":60,
                    "description":"Fully qualified error message from Oracle Utilities Application Framework in CDATA format."
                },
                "longDescription":{
                    "type":"string",
                    "maxLength":60,
                    "description":"The long message description from the Oracle Utilities Application Framework in CDATA format."
                }
            }
        }
    }
}

Nested Schema : serverMessage

Type: object

Show Source

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.

{
    "type":"object",
    "properties":{
        "messageCategory":{
            "type":"number",
            "maximum":0,
            "minimum":0,
            "description":"Message Category within Oracle Utilities Application Framework."
        },
        "messageNbr":{
            "type":"number",
            "maximum":99999,
            "minimum":-99999,
            "description":"Message Number within Oracle Utilities Application Framework."
        },
        "callSequence":{
            "type":"string",
            "maxLength":60,
            "description":"Delimited sequence of programs called."
        },
        "programName":{
            "type":"string",
            "maxLength":60,
            "description":"Name of the program that encountered the error."
        },
        "messageText":{
            "type":"string",
            "maxLength":60,
            "description":"Fully qualified error message from Oracle Utilities Application Framework in CDATA format."
        },
        "longDescription":{
            "type":"string",
            "maxLength":60,
            "description":"The long message description from the Oracle Utilities Application Framework in CDATA format."
        }
    }
}