Oracle Utilities REST API for Metering and Customer Information

Bill Segment Summary

get

https://server:port/spl/rest/apis/customer/financials/billSegments/{billSegmentId}/billSegmentSummary

Request

Path Parameters

billSegmentId(required): string

There's no request body for this operation.

Response

Supported Media Types

application/xml
application/json

200 Response

Success response

Root Schema : C1BilSegSmry

Type: object

Show Source

bill: object bill
billSegment: object billSegment
billSegmentInformation: string

Maximum Length: 254

Bill Segment Information
billSegmentStatus: string

Allowed Values: [ "10 ", "20 ", "30 ", "40 ", "50 ", "60 ", "70 " ]

Bill Segment Status: * `10 ` - Incomplete, * `20 ` - Error, * `30 ` - Freezable, * `40 ` - Pending Cancel, * `50 ` - Frozen, * `60 ` - Canceled, * `70 ` - OK
billSegmentStatusDescription: string

Maximum Length: 150

Description for bill segment's status.

Example: Freezable
billStatus: string

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

Bill Status is the bill's status. * `C ` - Complete, * `P ` - Pending

Example: C
calcLines: object calcLines
cancelReason: string

Maximum Length: 4

Cancel Reason defines why the bill segment(s) are being canceled.

Example: Wrong read
canRsnDesc: string

(canRsnDesc)
currentAmount: number

Current Amount is the bill segment's effect on the service agreement's current balance.

Example: $405.52
division: object division

The CIS division for service agreements is part of the service agreement's SA type. The SA type controls many business rules, and thus all business rules that are on the SA type are defined for a given jurisdiction and SA type combination.
endDate: string (date)

End Date
hasServiceQuantityOverride: boolean

SQ Override
isCancelled: boolean

The Cancel is used to cancel a Pending Cancel bill segment to become Canceled.

Example: true
isClosingBillSegment: boolean

If the Closing switch is on, this is the final bill segment for the service agreement (i.e., the service agreement has been stopped and this is the final bill segment).

Example: true
isEstimate: boolean

If the Estimate switch is on, consumption on this bill segment has been estimated by the system.

Example: true
isFrozen: boolean

The Freeze is used to freeze one or more bill segments.
isItemOverride: boolean

Item Override
periodStartDate: string (date)

Start Date
premise: object premise
premiseAddress: string

Maximum Length: 254

Premise details

Example: 7907B Norriton Cir NW, North Canton, OH, 44720
serviceAgreement: object serviceAgreement
serviceAgreementType: object serviceAgreementType
serviceQuantities: object serviceQuantities
serviceType: object serviceType

Service Type defines the type of service associated with the SA type.

{
    "type":"object",
    "properties":{
        "billSegmentInformation":{
            "type":"string",
            "maxLength":254,
            "description":"Bill Segment Information"
        },
        "billSegment":{
            "type":"object",
            "properties":{
                "_link":{
                    "type":"string",
                    "description":"_link"
                },
                "billSegmentId":{
                    "type":"string",
                    "maxLength":12,
                    "description":"Bill Segment ID is the system-assigned unique identifier of the bill segment.",
                    "example":"211366855400"
                }
            }
        },
        "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 on which the bill segment appears. A concatenation of its bill date, status, due date and amount is displayed.",
                    "example":"211122345678"
                }
            }
        },
        "serviceAgreement":{
            "type":"object",
            "properties":{
                "_link":{
                    "type":"string",
                    "description":"_link"
                },
                "serviceAgreementId":{
                    "type":"string",
                    "maxLength":10,
                    "description":"SA ID contains information about the bill segment's service agreement.",
                    "example":"0340281111"
                }
            }
        },
        "serviceType":{
            "type":"object",
            "description":"Service Type defines the type of service associated with the SA type.",
            "properties":{
                "_link":{
                    "type":"string",
                    "description":"_link"
                },
                "serviceType":{
                    "type":"string",
                    "maxLength":80,
                    "description":"Service Type defines the type of service associated with the SA type.",
                    "example":"E"
                }
            }
        },
        "division":{
            "type":"object",
            "description":"The CIS division for service agreements is part of the service agreement's SA type. The SA type controls many business rules, and thus all business rules that are on the SA type are defined for a given jurisdiction and SA type combination.",
            "properties":{
                "_link":{
                    "type":"string",
                    "description":"_link"
                },
                "division":{
                    "type":"string",
                    "maxLength":1,
                    "description":"The CIS division for service agreements is part of the service agreement's SA type. The SA type controls many business rules, and thus all business rules that are on the SA type are defined for a given jurisdiction and SA type combination.",
                    "example":"OH"
                },
                "divisionDescription":{
                    "type":"string",
                    "maxLength":1,
                    "description":"CIS Division"
                }
            }
        },
        "serviceAgreementType":{
            "type":"object",
            "properties":{
                "_link":{
                    "type":"string",
                    "description":"_link"
                },
                "serviceAgreementType":{
                    "type":"string",
                    "maxLength":8,
                    "description":"SA Type"
                },
                "serviceAgreementTypeDescription":{
                    "type":"string",
                    "maxLength":30,
                    "description":"Description for Service Agreement Type",
                    "example":"Electric residential (Add 1 day) - Ohio"
                }
            }
        },
        "billSegmentStatus":{
            "type":"string",
            "enum":[
                "10  ",
                "20  ",
                "30  ",
                "40  ",
                "50  ",
                "60  ",
                "70  "
            ],
            "description":"Bill Segment Status:\n* `10  ` - Incomplete,\n* `20  ` - Error,\n* `30  ` - Freezable,\n* `40  ` - Pending Cancel,\n* `50  ` - Frozen,\n* `60  ` - Canceled,\n* `70  ` - OK"
        },
        "billSegmentStatusDescription":{
            "type":"string",
            "maxLength":150,
            "description":"Description for bill segment's status.",
            "example":"Freezable"
        },
        "periodStartDate":{
            "type":"string",
            "format":"date",
            "description":"Start Date"
        },
        "endDate":{
            "type":"string",
            "format":"date",
            "description":"End Date"
        },
        "billStatus":{
            "type":"string",
            "enum":[
                "C   ",
                "P   "
            ],
            "description":"Bill Status is the bill's status.\n* `C   ` - Complete,\n* `P   ` - Pending",
            "example":"C"
        },
        "isFrozen":{
            "type":"boolean",
            "description":"The Freeze is used to freeze one or more bill segments."
        },
        "isCancelled":{
            "type":"boolean",
            "description":"The Cancel is used to cancel a Pending Cancel bill segment to become Canceled.",
            "example":"true"
        },
        "cancelReason":{
            "type":"string",
            "maxLength":4,
            "description":"Cancel Reason defines why the bill segment(s) are being canceled.",
            "example":"Wrong read"
        },
        "canRsnDesc":{
            "type":"string",
            "description":"(canRsnDesc)"
        },
        "isEstimate":{
            "type":"boolean",
            "description":"If the Estimate switch is on, consumption on this bill segment has been estimated by the system.",
            "example":"true"
        },
        "isClosingBillSegment":{
            "type":"boolean",
            "description":"If the Closing switch is on, this is the final bill segment for the service agreement (i.e., the service agreement has been stopped and this is the final bill segment).",
            "example":"true"
        },
        "hasServiceQuantityOverride":{
            "type":"boolean",
            "description":"SQ Override"
        },
        "isItemOverride":{
            "type":"boolean",
            "description":"Item Override"
        },
        "premise":{
            "type":"object",
            "properties":{
                "_link":{
                    "type":"string",
                    "description":"_link"
                },
                "premiseId":{
                    "type":"string",
                    "maxLength":10,
                    "description":"Premise ID defines the address on bills for persons who have their bill sent to the account's mailing premise."
                }
            }
        },
        "premiseAddress":{
            "type":"string",
            "maxLength":254,
            "description":"Premise details",
            "example":"7907B Norriton Cir NW, North Canton, OH, 44720"
        },
        "currentAmount":{
            "type":"number",
            "description":"Current Amount is the bill segment's effect on the service agreement's current balance.",
            "example":"$405.52"
        },
        "serviceQuantities":{
            "type":"object",
            "properties":{
                "_data":{
                    "type":"array",
                    "items":{
                        "type":"object",
                        "properties":{
                            "unitOfMeasure":{
                                "type":"object",
                                "properties":{
                                    "_link":{
                                        "type":"string",
                                        "description":"_link"
                                    },
                                    "unitOfMeasure":{
                                        "type":"string",
                                        "maxLength":30,
                                        "description":"Unit of Measure"
                                    }
                                }
                            },
                            "timeOfUse":{
                                "type":"object",
                                "properties":{
                                    "_link":{
                                        "type":"string",
                                        "description":"_link"
                                    },
                                    "timeOfUse":{
                                        "type":"string",
                                        "maxLength":30,
                                        "description":"Time of Use"
                                    }
                                }
                            },
                            "serviceQuantityIdentifier":{
                                "type":"object",
                                "properties":{
                                    "_link":{
                                        "type":"string",
                                        "description":"_link"
                                    },
                                    "serviceQuantityIdentifier":{
                                        "type":"string",
                                        "maxLength":30,
                                        "description":"SQI"
                                    }
                                }
                            },
                            "initialServiceQuantity":{
                                "type":"number",
                                "maximum":1.0E12,
                                "minimum":-1.0E12,
                                "description":"Initial Service Quantity is the initial quantity amassed by the system before application of the rate's pre-processing calculation group(s), if any exists.",
                                "example":"470.762600"
                            },
                            "billableServiceQuantity":{
                                "type":"number",
                                "maximum":1.0E12,
                                "minimum":-1.0E12,
                                "description":"Billable Service Quantity"
                            },
                            "version":{
                                "type":"number",
                                "maximum":99999,
                                "minimum":-99999,
                                "description":"Version"
                            },
                            "uomDesc":{
                                "type":"string",
                                "maxLength":60,
                                "description":"Description"
                            },
                            "touDesc":{
                                "type":"string",
                                "maxLength":60,
                                "description":"Description"
                            },
                            "sqiDesc":{
                                "type":"string",
                                "maxLength":60,
                                "description":"Description"
                            }
                        }
                    }
                }
            }
        },
        "calcLines":{
            "type":"object",
            "properties":{
                "_data":{
                    "type":"array",
                    "items":{
                        "type":"object",
                        "properties":{
                            "headerSequence":{
                                "type":"number",
                                "maximum":999,
                                "minimum":-999,
                                "description":"Header Sequence"
                            },
                            "startDate":{
                                "type":"string",
                                "format":"date",
                                "description":"Start Date"
                            },
                            "endDate":{
                                "type":"string",
                                "format":"date",
                                "description":"End Date"
                            },
                            "rateVersion":{
                                "type":"object",
                                "properties":{
                                    "_link":{
                                        "type":"string",
                                        "description":"_link"
                                    },
                                    "rateSchedule":{
                                        "type":"string",
                                        "maxLength":8,
                                        "description":"Rate Schedule"
                                    },
                                    "effectiveDate":{
                                        "type":"string",
                                        "format":"date",
                                        "description":"Effective Date"
                                    },
                                    "rateScheduleDescription":{
                                        "type":"string",
                                        "maxLength":60,
                                        "description":"Description"
                                    }
                                }
                            },
                            "calculatedAmount":{
                                "type":"number",
                                "description":"Calculated Amount"
                            },
                            "descriptionOnBill":{
                                "type":"string",
                                "maxLength":254,
                                "description":"Description on Bill"
                            },
                            "rateScheduleVersion":{
                                "type":"string",
                                "enum":[
                                    "C1V1",
                                    "C1V2"
                                ],
                                "description":"Rate Engine:\n* `C1V1` - Component-Based,\n* `C1V2` - Calculation Rule-Based"
                            },
                            "calculationLines":{
                                "type":"object",
                                "properties":{
                                    "_data":{
                                        "type":"array",
                                        "items":{
                                            "type":"object",
                                            "properties":{
                                                "sequence":{
                                                    "type":"number",
                                                    "maximum":99999,
                                                    "minimum":-99999,
                                                    "description":"Sequence"
                                                },
                                                "descriptionOnBill":{
                                                    "type":"string",
                                                    "maxLength":254,
                                                    "description":"Description on Bill"
                                                },
                                                "calculatedAmount":{
                                                    "type":"number",
                                                    "description":"Calculated Amount"
                                                },
                                                "shouldPrint":{
                                                    "type":"boolean",
                                                    "description":"The Print switch controls whether information about this line will print on the customer's bill.",
                                                    "example":"true"
                                                },
                                                "shouldAppearInSummary":{
                                                    "type":"boolean",
                                                    "description":"The Appears in Summary switch defines if this line's amount also appears on a summary line.",
                                                    "example":"true"
                                                }
                                            }
                                        }
                                    }
                                }
                            }
                        }
                    }
                }
            }
        }
    },
    "xml":{
        "name":"C1BilSegSmry"
    }
}

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 on which the bill segment appears. A concatenation of its bill date, status, due date and amount is displayed.

Example: 211122345678

{
    "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 on which the bill segment appears. A concatenation of its bill date, status, due date and amount is displayed.",
            "example":"211122345678"
        }
    }
}

Nested Schema : billSegment

Type: object

Show Source

_link: string

_link
billSegmentId: string

Maximum Length: 12

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

Example: 211366855400

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

Nested Schema : calcLines

Type: object

Show Source

_data: array _data

{
    "type":"object",
    "properties":{
        "_data":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "headerSequence":{
                        "type":"number",
                        "maximum":999,
                        "minimum":-999,
                        "description":"Header Sequence"
                    },
                    "startDate":{
                        "type":"string",
                        "format":"date",
                        "description":"Start Date"
                    },
                    "endDate":{
                        "type":"string",
                        "format":"date",
                        "description":"End Date"
                    },
                    "rateVersion":{
                        "type":"object",
                        "properties":{
                            "_link":{
                                "type":"string",
                                "description":"_link"
                            },
                            "rateSchedule":{
                                "type":"string",
                                "maxLength":8,
                                "description":"Rate Schedule"
                            },
                            "effectiveDate":{
                                "type":"string",
                                "format":"date",
                                "description":"Effective Date"
                            },
                            "rateScheduleDescription":{
                                "type":"string",
                                "maxLength":60,
                                "description":"Description"
                            }
                        }
                    },
                    "calculatedAmount":{
                        "type":"number",
                        "description":"Calculated Amount"
                    },
                    "descriptionOnBill":{
                        "type":"string",
                        "maxLength":254,
                        "description":"Description on Bill"
                    },
                    "rateScheduleVersion":{
                        "type":"string",
                        "enum":[
                            "C1V1",
                            "C1V2"
                        ],
                        "description":"Rate Engine:\n* `C1V1` - Component-Based,\n* `C1V2` - Calculation Rule-Based"
                    },
                    "calculationLines":{
                        "type":"object",
                        "properties":{
                            "_data":{
                                "type":"array",
                                "items":{
                                    "type":"object",
                                    "properties":{
                                        "sequence":{
                                            "type":"number",
                                            "maximum":99999,
                                            "minimum":-99999,
                                            "description":"Sequence"
                                        },
                                        "descriptionOnBill":{
                                            "type":"string",
                                            "maxLength":254,
                                            "description":"Description on Bill"
                                        },
                                        "calculatedAmount":{
                                            "type":"number",
                                            "description":"Calculated Amount"
                                        },
                                        "shouldPrint":{
                                            "type":"boolean",
                                            "description":"The Print switch controls whether information about this line will print on the customer's bill.",
                                            "example":"true"
                                        },
                                        "shouldAppearInSummary":{
                                            "type":"boolean",
                                            "description":"The Appears in Summary switch defines if this line's amount also appears on a summary line.",
                                            "example":"true"
                                        }
                                    }
                                }
                            }
                        }
                    }
                }
            }
        }
    }
}

Nested Schema : division

Type: object

The CIS division for service agreements is part of the service agreement's SA type. The SA type controls many business rules, and thus all business rules that are on the SA type are defined for a given jurisdiction and SA type combination.

Show Source

_link: string

_link
division: string

Maximum Length: 1

The CIS division for service agreements is part of the service agreement's SA type. The SA type controls many business rules, and thus all business rules that are on the SA type are defined for a given jurisdiction and SA type combination.

Example: OH
divisionDescription: string

Maximum Length: 1

CIS Division

{
    "type":"object",
    "description":"The CIS division for service agreements is part of the service agreement's SA type. The SA type controls many business rules, and thus all business rules that are on the SA type are defined for a given jurisdiction and SA type combination.",
    "properties":{
        "_link":{
            "type":"string",
            "description":"_link"
        },
        "division":{
            "type":"string",
            "maxLength":1,
            "description":"The CIS division for service agreements is part of the service agreement's SA type. The SA type controls many business rules, and thus all business rules that are on the SA type are defined for a given jurisdiction and SA type combination.",
            "example":"OH"
        },
        "divisionDescription":{
            "type":"string",
            "maxLength":1,
            "description":"CIS Division"
        }
    }
}

Nested Schema : premise

Type: object

Show Source

_link: string

_link
premiseId: string

Maximum Length: 10

Premise ID defines the address on bills for persons who have their bill sent to the account's mailing premise.

{
    "type":"object",
    "properties":{
        "_link":{
            "type":"string",
            "description":"_link"
        },
        "premiseId":{
            "type":"string",
            "maxLength":10,
            "description":"Premise ID defines the address on bills for persons who have their bill sent to the account's mailing premise."
        }
    }
}

Nested Schema : serviceAgreement

Type: object

Show Source

_link: string

_link
serviceAgreementId: string

Maximum Length: 10

SA ID contains information about the bill segment's service agreement.

Example: 0340281111

{
    "type":"object",
    "properties":{
        "_link":{
            "type":"string",
            "description":"_link"
        },
        "serviceAgreementId":{
            "type":"string",
            "maxLength":10,
            "description":"SA ID contains information about the bill segment's service agreement.",
            "example":"0340281111"
        }
    }
}

Nested Schema : serviceAgreementType

Type: object

Show Source

_link: string

_link
serviceAgreementType: string

Maximum Length: 8

SA Type
serviceAgreementTypeDescription: string

Maximum Length: 30

Description for Service Agreement Type

Example: Electric residential (Add 1 day) - Ohio

{
    "type":"object",
    "properties":{
        "_link":{
            "type":"string",
            "description":"_link"
        },
        "serviceAgreementType":{
            "type":"string",
            "maxLength":8,
            "description":"SA Type"
        },
        "serviceAgreementTypeDescription":{
            "type":"string",
            "maxLength":30,
            "description":"Description for Service Agreement Type",
            "example":"Electric residential (Add 1 day) - Ohio"
        }
    }
}

Nested Schema : serviceQuantities

Type: object

Show Source

_data: array _data

{
    "type":"object",
    "properties":{
        "_data":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "unitOfMeasure":{
                        "type":"object",
                        "properties":{
                            "_link":{
                                "type":"string",
                                "description":"_link"
                            },
                            "unitOfMeasure":{
                                "type":"string",
                                "maxLength":30,
                                "description":"Unit of Measure"
                            }
                        }
                    },
                    "timeOfUse":{
                        "type":"object",
                        "properties":{
                            "_link":{
                                "type":"string",
                                "description":"_link"
                            },
                            "timeOfUse":{
                                "type":"string",
                                "maxLength":30,
                                "description":"Time of Use"
                            }
                        }
                    },
                    "serviceQuantityIdentifier":{
                        "type":"object",
                        "properties":{
                            "_link":{
                                "type":"string",
                                "description":"_link"
                            },
                            "serviceQuantityIdentifier":{
                                "type":"string",
                                "maxLength":30,
                                "description":"SQI"
                            }
                        }
                    },
                    "initialServiceQuantity":{
                        "type":"number",
                        "maximum":1.0E12,
                        "minimum":-1.0E12,
                        "description":"Initial Service Quantity is the initial quantity amassed by the system before application of the rate's pre-processing calculation group(s), if any exists.",
                        "example":"470.762600"
                    },
                    "billableServiceQuantity":{
                        "type":"number",
                        "maximum":1.0E12,
                        "minimum":-1.0E12,
                        "description":"Billable Service Quantity"
                    },
                    "version":{
                        "type":"number",
                        "maximum":99999,
                        "minimum":-99999,
                        "description":"Version"
                    },
                    "uomDesc":{
                        "type":"string",
                        "maxLength":60,
                        "description":"Description"
                    },
                    "touDesc":{
                        "type":"string",
                        "maxLength":60,
                        "description":"Description"
                    },
                    "sqiDesc":{
                        "type":"string",
                        "maxLength":60,
                        "description":"Description"
                    }
                }
            }
        }
    }
}

Nested Schema : serviceType

Type: object

Service Type defines the type of service associated with the SA type.

Show Source

_link: string

_link
serviceType: string

Maximum Length: 80

Service Type defines the type of service associated with the SA type.

Example: E

{
    "type":"object",
    "description":"Service Type defines the type of service associated with the SA type.",
    "properties":{
        "_link":{
            "type":"string",
            "description":"_link"
        },
        "serviceType":{
            "type":"string",
            "maxLength":80,
            "description":"Service Type defines the type of service associated with the SA type.",
            "example":"E"
        }
    }
}

Nested Schema : _data

Type: array

Show Source

Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "headerSequence":{
                "type":"number",
                "maximum":999,
                "minimum":-999,
                "description":"Header Sequence"
            },
            "startDate":{
                "type":"string",
                "format":"date",
                "description":"Start Date"
            },
            "endDate":{
                "type":"string",
                "format":"date",
                "description":"End Date"
            },
            "rateVersion":{
                "type":"object",
                "properties":{
                    "_link":{
                        "type":"string",
                        "description":"_link"
                    },
                    "rateSchedule":{
                        "type":"string",
                        "maxLength":8,
                        "description":"Rate Schedule"
                    },
                    "effectiveDate":{
                        "type":"string",
                        "format":"date",
                        "description":"Effective Date"
                    },
                    "rateScheduleDescription":{
                        "type":"string",
                        "maxLength":60,
                        "description":"Description"
                    }
                }
            },
            "calculatedAmount":{
                "type":"number",
                "description":"Calculated Amount"
            },
            "descriptionOnBill":{
                "type":"string",
                "maxLength":254,
                "description":"Description on Bill"
            },
            "rateScheduleVersion":{
                "type":"string",
                "enum":[
                    "C1V1",
                    "C1V2"
                ],
                "description":"Rate Engine:\n* `C1V1` - Component-Based,\n* `C1V2` - Calculation Rule-Based"
            },
            "calculationLines":{
                "type":"object",
                "properties":{
                    "_data":{
                        "type":"array",
                        "items":{
                            "type":"object",
                            "properties":{
                                "sequence":{
                                    "type":"number",
                                    "maximum":99999,
                                    "minimum":-99999,
                                    "description":"Sequence"
                                },
                                "descriptionOnBill":{
                                    "type":"string",
                                    "maxLength":254,
                                    "description":"Description on Bill"
                                },
                                "calculatedAmount":{
                                    "type":"number",
                                    "description":"Calculated Amount"
                                },
                                "shouldPrint":{
                                    "type":"boolean",
                                    "description":"The Print switch controls whether information about this line will print on the customer's bill.",
                                    "example":"true"
                                },
                                "shouldAppearInSummary":{
                                    "type":"boolean",
                                    "description":"The Appears in Summary switch defines if this line's amount also appears on a summary line.",
                                    "example":"true"
                                }
                            }
                        }
                    }
                }
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

calculatedAmount: number

Calculated Amount
calculationLines: object calculationLines
descriptionOnBill: string

Maximum Length: 254

Description on Bill
endDate: string (date)

End Date
headerSequence: number

Minimum Value: -999

Maximum Value: 999

Header Sequence
rateScheduleVersion: string

Allowed Values: [ "C1V1", "C1V2" ]

Rate Engine: * `C1V1` - Component-Based, * `C1V2` - Calculation Rule-Based
rateVersion: object rateVersion
startDate: string (date)

Start Date

{
    "type":"object",
    "properties":{
        "headerSequence":{
            "type":"number",
            "maximum":999,
            "minimum":-999,
            "description":"Header Sequence"
        },
        "startDate":{
            "type":"string",
            "format":"date",
            "description":"Start Date"
        },
        "endDate":{
            "type":"string",
            "format":"date",
            "description":"End Date"
        },
        "rateVersion":{
            "type":"object",
            "properties":{
                "_link":{
                    "type":"string",
                    "description":"_link"
                },
                "rateSchedule":{
                    "type":"string",
                    "maxLength":8,
                    "description":"Rate Schedule"
                },
                "effectiveDate":{
                    "type":"string",
                    "format":"date",
                    "description":"Effective Date"
                },
                "rateScheduleDescription":{
                    "type":"string",
                    "maxLength":60,
                    "description":"Description"
                }
            }
        },
        "calculatedAmount":{
            "type":"number",
            "description":"Calculated Amount"
        },
        "descriptionOnBill":{
            "type":"string",
            "maxLength":254,
            "description":"Description on Bill"
        },
        "rateScheduleVersion":{
            "type":"string",
            "enum":[
                "C1V1",
                "C1V2"
            ],
            "description":"Rate Engine:\n* `C1V1` - Component-Based,\n* `C1V2` - Calculation Rule-Based"
        },
        "calculationLines":{
            "type":"object",
            "properties":{
                "_data":{
                    "type":"array",
                    "items":{
                        "type":"object",
                        "properties":{
                            "sequence":{
                                "type":"number",
                                "maximum":99999,
                                "minimum":-99999,
                                "description":"Sequence"
                            },
                            "descriptionOnBill":{
                                "type":"string",
                                "maxLength":254,
                                "description":"Description on Bill"
                            },
                            "calculatedAmount":{
                                "type":"number",
                                "description":"Calculated Amount"
                            },
                            "shouldPrint":{
                                "type":"boolean",
                                "description":"The Print switch controls whether information about this line will print on the customer's bill.",
                                "example":"true"
                            },
                            "shouldAppearInSummary":{
                                "type":"boolean",
                                "description":"The Appears in Summary switch defines if this line's amount also appears on a summary line.",
                                "example":"true"
                            }
                        }
                    }
                }
            }
        }
    }
}

Nested Schema : calculationLines

Type: object

Show Source

_data: array _data

{
    "type":"object",
    "properties":{
        "_data":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "sequence":{
                        "type":"number",
                        "maximum":99999,
                        "minimum":-99999,
                        "description":"Sequence"
                    },
                    "descriptionOnBill":{
                        "type":"string",
                        "maxLength":254,
                        "description":"Description on Bill"
                    },
                    "calculatedAmount":{
                        "type":"number",
                        "description":"Calculated Amount"
                    },
                    "shouldPrint":{
                        "type":"boolean",
                        "description":"The Print switch controls whether information about this line will print on the customer's bill.",
                        "example":"true"
                    },
                    "shouldAppearInSummary":{
                        "type":"boolean",
                        "description":"The Appears in Summary switch defines if this line's amount also appears on a summary line.",
                        "example":"true"
                    }
                }
            }
        }
    }
}

Nested Schema : rateVersion

Type: object

Show Source

_link: string

_link
effectiveDate: string (date)

Effective Date
rateSchedule: string

Maximum Length: 8

Rate Schedule
rateScheduleDescription: string

Maximum Length: 60

Description

{
    "type":"object",
    "properties":{
        "_link":{
            "type":"string",
            "description":"_link"
        },
        "rateSchedule":{
            "type":"string",
            "maxLength":8,
            "description":"Rate Schedule"
        },
        "effectiveDate":{
            "type":"string",
            "format":"date",
            "description":"Effective Date"
        },
        "rateScheduleDescription":{
            "type":"string",
            "maxLength":60,
            "description":"Description"
        }
    }
}

Nested Schema : _data

Type: array

Show Source

Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "sequence":{
                "type":"number",
                "maximum":99999,
                "minimum":-99999,
                "description":"Sequence"
            },
            "descriptionOnBill":{
                "type":"string",
                "maxLength":254,
                "description":"Description on Bill"
            },
            "calculatedAmount":{
                "type":"number",
                "description":"Calculated Amount"
            },
            "shouldPrint":{
                "type":"boolean",
                "description":"The Print switch controls whether information about this line will print on the customer's bill.",
                "example":"true"
            },
            "shouldAppearInSummary":{
                "type":"boolean",
                "description":"The Appears in Summary switch defines if this line's amount also appears on a summary line.",
                "example":"true"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

calculatedAmount: number

Calculated Amount
descriptionOnBill: string

Maximum Length: 254

Description on Bill
sequence: number

Minimum Value: -99999

Maximum Value: 99999

Sequence
shouldAppearInSummary: boolean

The Appears in Summary switch defines if this line's amount also appears on a summary line.

Example: true
shouldPrint: boolean

The Print switch controls whether information about this line will print on the customer's bill.

Example: true

{
    "type":"object",
    "properties":{
        "sequence":{
            "type":"number",
            "maximum":99999,
            "minimum":-99999,
            "description":"Sequence"
        },
        "descriptionOnBill":{
            "type":"string",
            "maxLength":254,
            "description":"Description on Bill"
        },
        "calculatedAmount":{
            "type":"number",
            "description":"Calculated Amount"
        },
        "shouldPrint":{
            "type":"boolean",
            "description":"The Print switch controls whether information about this line will print on the customer's bill.",
            "example":"true"
        },
        "shouldAppearInSummary":{
            "type":"boolean",
            "description":"The Appears in Summary switch defines if this line's amount also appears on a summary line.",
            "example":"true"
        }
    }
}

Nested Schema : _data

Type: array

Show Source

Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "unitOfMeasure":{
                "type":"object",
                "properties":{
                    "_link":{
                        "type":"string",
                        "description":"_link"
                    },
                    "unitOfMeasure":{
                        "type":"string",
                        "maxLength":30,
                        "description":"Unit of Measure"
                    }
                }
            },
            "timeOfUse":{
                "type":"object",
                "properties":{
                    "_link":{
                        "type":"string",
                        "description":"_link"
                    },
                    "timeOfUse":{
                        "type":"string",
                        "maxLength":30,
                        "description":"Time of Use"
                    }
                }
            },
            "serviceQuantityIdentifier":{
                "type":"object",
                "properties":{
                    "_link":{
                        "type":"string",
                        "description":"_link"
                    },
                    "serviceQuantityIdentifier":{
                        "type":"string",
                        "maxLength":30,
                        "description":"SQI"
                    }
                }
            },
            "initialServiceQuantity":{
                "type":"number",
                "maximum":1.0E12,
                "minimum":-1.0E12,
                "description":"Initial Service Quantity is the initial quantity amassed by the system before application of the rate's pre-processing calculation group(s), if any exists.",
                "example":"470.762600"
            },
            "billableServiceQuantity":{
                "type":"number",
                "maximum":1.0E12,
                "minimum":-1.0E12,
                "description":"Billable Service Quantity"
            },
            "version":{
                "type":"number",
                "maximum":99999,
                "minimum":-99999,
                "description":"Version"
            },
            "uomDesc":{
                "type":"string",
                "maxLength":60,
                "description":"Description"
            },
            "touDesc":{
                "type":"string",
                "maxLength":60,
                "description":"Description"
            },
            "sqiDesc":{
                "type":"string",
                "maxLength":60,
                "description":"Description"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

billableServiceQuantity: number

Minimum Value: -1.0E12

Maximum Value: 1.0E12

Billable Service Quantity
initialServiceQuantity: number

Minimum Value: -1.0E12

Maximum Value: 1.0E12

Initial Service Quantity is the initial quantity amassed by the system before application of the rate's pre-processing calculation group(s), if any exists.

Example: 470.762600
serviceQuantityIdentifier: object serviceQuantityIdentifier
sqiDesc: string

Maximum Length: 60

Description
timeOfUse: object timeOfUse
touDesc: string

Maximum Length: 60

Description
unitOfMeasure: object unitOfMeasure
uomDesc: string

Maximum Length: 60

Description
version: number

Minimum Value: -99999

Maximum Value: 99999

Version

{
    "type":"object",
    "properties":{
        "unitOfMeasure":{
            "type":"object",
            "properties":{
                "_link":{
                    "type":"string",
                    "description":"_link"
                },
                "unitOfMeasure":{
                    "type":"string",
                    "maxLength":30,
                    "description":"Unit of Measure"
                }
            }
        },
        "timeOfUse":{
            "type":"object",
            "properties":{
                "_link":{
                    "type":"string",
                    "description":"_link"
                },
                "timeOfUse":{
                    "type":"string",
                    "maxLength":30,
                    "description":"Time of Use"
                }
            }
        },
        "serviceQuantityIdentifier":{
            "type":"object",
            "properties":{
                "_link":{
                    "type":"string",
                    "description":"_link"
                },
                "serviceQuantityIdentifier":{
                    "type":"string",
                    "maxLength":30,
                    "description":"SQI"
                }
            }
        },
        "initialServiceQuantity":{
            "type":"number",
            "maximum":1.0E12,
            "minimum":-1.0E12,
            "description":"Initial Service Quantity is the initial quantity amassed by the system before application of the rate's pre-processing calculation group(s), if any exists.",
            "example":"470.762600"
        },
        "billableServiceQuantity":{
            "type":"number",
            "maximum":1.0E12,
            "minimum":-1.0E12,
            "description":"Billable Service Quantity"
        },
        "version":{
            "type":"number",
            "maximum":99999,
            "minimum":-99999,
            "description":"Version"
        },
        "uomDesc":{
            "type":"string",
            "maxLength":60,
            "description":"Description"
        },
        "touDesc":{
            "type":"string",
            "maxLength":60,
            "description":"Description"
        },
        "sqiDesc":{
            "type":"string",
            "maxLength":60,
            "description":"Description"
        }
    }
}

Nested Schema : serviceQuantityIdentifier

Type: object

Show Source

_link: string

_link
serviceQuantityIdentifier: string

Maximum Length: 30

SQI

{
    "type":"object",
    "properties":{
        "_link":{
            "type":"string",
            "description":"_link"
        },
        "serviceQuantityIdentifier":{
            "type":"string",
            "maxLength":30,
            "description":"SQI"
        }
    }
}

Nested Schema : timeOfUse

Type: object

Show Source

_link: string

_link
timeOfUse: string

Maximum Length: 30

Time of Use

{
    "type":"object",
    "properties":{
        "_link":{
            "type":"string",
            "description":"_link"
        },
        "timeOfUse":{
            "type":"string",
            "maxLength":30,
            "description":"Time of Use"
        }
    }
}

Nested Schema : unitOfMeasure

Type: object

Show Source

_link: string

_link
unitOfMeasure: string

Maximum Length: 30

Unit of Measure

{
    "type":"object",
    "properties":{
        "_link":{
            "type":"string",
            "description":"_link"
        },
        "unitOfMeasure":{
            "type":"string",
            "maxLength":30,
            "description":"Unit of Measure"
        }
    }
}

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."
        }
    }
}