Oracle Utilities REST API for Metering and Customer Information

Action Bill

patch

https://server:port/spl/rest/apis/customer/financials/bills/{billId}/lifecycle

This operation updates the Bill and Bill Segments status for the provided Bill id.

Request

Path Parameters

billId(required): string

Supported Media Types

application/xml
application/json

Root Schema : schema

Type: object

Show Source

accountingDate: string (date)

Accounting Date defines the financial period to which the canceled and new bill segments' financial transactions are booked.

Example: 2021-10-05
action: string

Allowed Values: [ "C1CF", "C1CO", "C1CR", "C1DE", "C1FR", "C1GN", "C1RO" ]

ACTION * `C1CF` - CancelFrozen, * `C1CO` - Complete, * `C1CR` - Credit Note, * `C1DE` - Delete, * `C1FR` - Freeze, * `C1GN` - Generate, * `C1RO` - ReOpen

Example: cancelFrozen
areEstimatesAllowed: boolean

Allow Estimates is defined as true if the system is allowed to estimate consumption when a meter read cannot be retrieved.

Example: false
billDate: string (date)

Bill Date is the business date that was used when the bill was completed.
cancelReason: string

Maximum Length: 4

Cancel Reason defines why bill segments are being canceled.
creditNoteDate: string (date)

Credit Note date is the date on which all bill segments are cancelled and a new bill gets generated which contains the cancellation details.
cutOffDate: string (date)

Cutoff Date is the last possible day of each bill period for a bill segment.

Example: 2021-10-05
hasBillingOption: boolean

Billing Option defines how the system looks for meter reads.

Example: false

{
    "type":"object",
    "properties":{
        "action":{
            "type":"string",
            "enum":[
                "C1CF",
                "C1CO",
                "C1CR",
                "C1DE",
                "C1FR",
                "C1GN",
                "C1RO"
            ],
            "description":"ACTION\n* `C1CF` - CancelFrozen,\n* `C1CO` - Complete,\n* `C1CR` - Credit Note,\n* `C1DE` - Delete,\n* `C1FR` - Freeze,\n* `C1GN` - Generate,\n* `C1RO` - ReOpen",
            "example":"cancelFrozen"
        },
        "accountingDate":{
            "type":"string",
            "format":"date",
            "description":"Accounting Date defines the financial period to which the canceled and new bill segments' financial transactions are booked.",
            "example":"2021-10-05"
        },
        "cutOffDate":{
            "type":"string",
            "format":"date",
            "description":"Cutoff Date is the last possible day of each bill period for a bill segment.",
            "example":"2021-10-05"
        },
        "areEstimatesAllowed":{
            "type":"boolean",
            "description":"Allow Estimates is defined as true if the system is allowed to estimate consumption when a meter read cannot be retrieved.",
            "example":"false"
        },
        "hasBillingOption":{
            "type":"boolean",
            "description":"Billing Option defines how the system looks for meter reads.",
            "example":"false"
        },
        "billDate":{
            "type":"string",
            "format":"date",
            "description":"Bill Date is the business date that was used when the bill was completed."
        },
        "cancelReason":{
            "type":"string",
            "maxLength":4,
            "description":"Cancel Reason defines why bill segments are being canceled."
        },
        "creditNoteDate":{
            "type":"string",
            "format":"date",
            "description":"Credit Note date is the date on which all bill segments are cancelled and a new bill gets  generated which contains the cancellation details."
        }
    },
    "xml":{
        "name":"C1ActionBill"
    }
}

Root Schema : schema

Type: object

Show Source

accountingDate: string (date)

Accounting Date defines the financial period to which the canceled and new bill segments' financial transactions are booked.

Example: 2021-10-05
action: string

Allowed Values: [ "C1CF", "C1CO", "C1CR", "C1DE", "C1FR", "C1GN", "C1RO" ]

ACTION * `C1CF` - CancelFrozen, * `C1CO` - Complete, * `C1CR` - Credit Note, * `C1DE` - Delete, * `C1FR` - Freeze, * `C1GN` - Generate, * `C1RO` - ReOpen

Example: cancelFrozen
areEstimatesAllowed: boolean

Allow Estimates is defined as true if the system is allowed to estimate consumption when a meter read cannot be retrieved.

Example: false
billDate: string (date)

Bill Date is the business date that was used when the bill was completed.
cancelReason: string

Maximum Length: 4

Cancel Reason defines why bill segments are being canceled.
creditNoteDate: string (date)

Credit Note date is the date on which all bill segments are cancelled and a new bill gets generated which contains the cancellation details.
cutOffDate: string (date)

Cutoff Date is the last possible day of each bill period for a bill segment.

Example: 2021-10-05
hasBillingOption: boolean

Billing Option defines how the system looks for meter reads.

Example: false

{
    "type":"object",
    "properties":{
        "action":{
            "type":"string",
            "enum":[
                "C1CF",
                "C1CO",
                "C1CR",
                "C1DE",
                "C1FR",
                "C1GN",
                "C1RO"
            ],
            "description":"ACTION\n* `C1CF` - CancelFrozen,\n* `C1CO` - Complete,\n* `C1CR` - Credit Note,\n* `C1DE` - Delete,\n* `C1FR` - Freeze,\n* `C1GN` - Generate,\n* `C1RO` - ReOpen",
            "example":"cancelFrozen"
        },
        "accountingDate":{
            "type":"string",
            "format":"date",
            "description":"Accounting Date defines the financial period to which the canceled and new bill segments' financial transactions are booked.",
            "example":"2021-10-05"
        },
        "cutOffDate":{
            "type":"string",
            "format":"date",
            "description":"Cutoff Date is the last possible day of each bill period for a bill segment.",
            "example":"2021-10-05"
        },
        "areEstimatesAllowed":{
            "type":"boolean",
            "description":"Allow Estimates is defined as true if the system is allowed to estimate consumption when a meter read cannot be retrieved.",
            "example":"false"
        },
        "hasBillingOption":{
            "type":"boolean",
            "description":"Billing Option defines how the system looks for meter reads.",
            "example":"false"
        },
        "billDate":{
            "type":"string",
            "format":"date",
            "description":"Bill Date is the business date that was used when the bill was completed."
        },
        "cancelReason":{
            "type":"string",
            "maxLength":4,
            "description":"Cancel Reason defines why bill segments are being canceled."
        },
        "creditNoteDate":{
            "type":"string",
            "format":"date",
            "description":"Credit Note date is the date on which all bill segments are cancelled and a new bill gets  generated which contains the cancellation details."
        }
    },
    "xml":{
        "name":"C1ActionBill"
    }
}

Response

Supported Media Types

application/xml
application/json

200 Response

Success response

Root Schema : C1ActionBill

Type: object

Show Source

action: string

Allowed Values: [ "C1CF", "C1CO", "C1CR", "C1DE", "C1FR", "C1GN", "C1RO" ]

ACTION * `C1CF` - CancelFrozen, * `C1CO` - Complete, * `C1CR` - Credit Note, * `C1DE` - Delete, * `C1FR` - Freeze, * `C1GN` - Generate, * `C1RO` - ReOpen

Example: cancelFrozen
bill: object bill
billStatus: 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
nextActions: array nextActions

{
    "type":"object",
    "properties":{
        "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"
                }
            }
        },
        "action":{
            "type":"string",
            "enum":[
                "C1CF",
                "C1CO",
                "C1CR",
                "C1DE",
                "C1FR",
                "C1GN",
                "C1RO"
            ],
            "description":"ACTION\n* `C1CF` - CancelFrozen,\n* `C1CO` - Complete,\n* `C1CR` - Credit Note,\n* `C1DE` - Delete,\n* `C1FR` - Freeze,\n* `C1GN` - Generate,\n* `C1RO` - ReOpen",
            "example":"cancelFrozen"
        },
        "billStatus":{
            "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"
        },
        "nextActions":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "action":{
                        "type":"string",
                        "enum":[
                            "C1CF",
                            "C1CO",
                            "C1CR",
                            "C1DE",
                            "C1FR",
                            "C1GN",
                            "C1RO"
                        ],
                        "description":"ACTION\n* `C1CF` - CancelFrozen,\n* `C1CO` - Complete,\n* `C1CR` - Credit Note,\n* `C1DE` - Delete,\n* `C1FR` - Freeze,\n* `C1GN` - Generate,\n* `C1RO` - ReOpen",
                        "example":"cancelFrozen"
                    }
                }
            }
        }
    },
    "xml":{
        "name":"C1ActionBill"
    }
}

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

Type: array

Show Source

Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "action":{
                "type":"string",
                "enum":[
                    "C1CF",
                    "C1CO",
                    "C1CR",
                    "C1DE",
                    "C1FR",
                    "C1GN",
                    "C1RO"
                ],
                "description":"ACTION\n* `C1CF` - CancelFrozen,\n* `C1CO` - Complete,\n* `C1CR` - Credit Note,\n* `C1DE` - Delete,\n* `C1FR` - Freeze,\n* `C1GN` - Generate,\n* `C1RO` - ReOpen",
                "example":"cancelFrozen"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

action: string

Allowed Values: [ "C1CF", "C1CO", "C1CR", "C1DE", "C1FR", "C1GN", "C1RO" ]

ACTION * `C1CF` - CancelFrozen, * `C1CO` - Complete, * `C1CR` - Credit Note, * `C1DE` - Delete, * `C1FR` - Freeze, * `C1GN` - Generate, * `C1RO` - ReOpen

Example: cancelFrozen

{
    "type":"object",
    "properties":{
        "action":{
            "type":"string",
            "enum":[
                "C1CF",
                "C1CO",
                "C1CR",
                "C1DE",
                "C1FR",
                "C1GN",
                "C1RO"
            ],
            "description":"ACTION\n* `C1CF` - CancelFrozen,\n* `C1CO` - Complete,\n* `C1CR` - Credit Note,\n* `C1DE` - Delete,\n* `C1FR` - Freeze,\n* `C1GN` - Generate,\n* `C1RO` - ReOpen",
            "example":"cancelFrozen"
        }
    }
}

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