Oracle Utilities REST API for Metering and Customer Information

Get Payment

get

/rest/apis/customer/financials/payments/{paymentId}

Request

Path Parameters

paymentId(required): string
Payment ID is the system-assigned unique identifier of the payment.
Example:
```
317896608844
```

There's no request body for this operation.

Response

Supported Media Types

application/xml
application/json

200 Response

Success response

Root Schema : C1-CxPayment

Type: object

Show Source

_self: string

_self
account: object account
accountCheckDigit: string

Maximum Length: 1

Account Check Digit
cancelReason: string

Maximum Length: 30

If the payment is canceled, the Cancel Reason is displayed.

Example: Data entry error
characteristics: object characteristics
currency: object currency
Exception: object Exception
isNonCISAccount: boolean

Non-CIS Account Switch

Example: true
isOpenItemAccounting: boolean

Open Item Accounting Switch

Example: false
isPayTransfer: boolean

When Payment Transfer button is clicked, the Payment Event Transfer dialog opens to transfer a payment.

Example: true
matchType: object matchType

Match Type and Match Value will only be used if either of the following conditions is true: The Account ID belongs to an open item customer class. In this situation, specify a Match Type to define how the payment should be matched to the customer's open-items and use Match Value to define the open-items covered by the payment The customer wants to restrict the distribution of the payment to a specific service agreement. In this situation, specify a Match Type of "service agreement ID" and a Match Value of the respective service agreement ID. Match Type and Match Value are gray after the payment is frozen.
matchValue: string

Maximum Length: 30

Match Type and Match Value will only be used if either of the following conditions is true: The Account ID belongs to an open item customer class. In this situation, specify a Match Type to define how the payment should be matched to the customer's open-items and use Match Value to define the open-items covered by the payment The customer wants to restrict the distribution of the payment to a specific service agreement. In this situation, specify a Match Type of "service agreement ID" and a Match Value of the respective service agreement ID. Match Type and Match Value are gray after the payment is frozen.
nextActions: array nextActions
nonCisComments: string

Maximum Length: 254

If the payment is linked to an Account ID that belongs to a customer class that is used for non-CIS payments, the following fields appear (note, these fields are gray after the payment is frozen): Name is the name of the person remitting the payment. Reference Number is the reference number of the item being paid. For example, the property tax reference number. Comments are used to describe anything unusual about the non-CIS payment.
nonCisName: string

Maximum Length: 50

If the payment is linked to an Account ID that belongs to a customer class that is used for non-CIS payments, the following fields appear (note, these fields are gray after the payment is frozen): Name is the name of the person remitting the payment. Reference Number is the reference number of the item being paid. For example, the property tax reference number. Comments are used to describe anything unusual about the non-CIS payment. For this one I would recommend something such as: If the payment is linked to an Account ID that belongs to a customer class that is used for non-CIS payments, the Name defines the name of the person remitting the payment.

Example: ZZMXA,CX_test
nonCisReferenceNumber: string

Maximum Length: 30

If the payment is linked to an Account ID that belongs to a customer class that is used for non-CIS payments, the following fields appear (note, these fields are gray after the payment is frozen): Name is the name of the person remitting the payment. Reference Number is the reference number of the item being paid. For example, the property tax reference number. Comments are used to describe anything unusual about the non-CIS payment.
paymentAccountCash: string

Maximum Length: 30

Use Cash-Only Threshold to define the number of cash-only points a customer must have before the system warns the customer service representative accepting payments that the account is cash-only.
paymentAmount: number

Payment Amount is the amount of the payment. This field is gray after the payment is frozen.

Example: 300
paymentEvent: object paymentEvent
paymentId: string

Maximum Length: 12

Payment ID is the system-assigned unique identifier of the payment.

Example: 317896608844
paymentStatus: string

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

Payment Status is the payment's status. * `10 ` - Incomplete, * `20 ` - Error, * `30 ` - Freezable, * `50 ` - Frozen, * `60 ` - Canceled

Example: 30
paySegments: object paySegments
transferAccountId: string

Maximum Length: 10

Account ID is the account to which the payment event should be transferred.
transferCancelReason: string

Maximum Length: 4

Cancel Reason defines why you are performing the payment event transfer.

Example: NSF (Non sufficient funds)
transferMatchType: string

Maximum Length: 8

Match Type and Match Value are defaulted based on their values for the payment event that you are transferring. If necessary, modify the values appropriately for the account to which you are transferring the payment event.

Example: BILL-ID (Bill ID / Sequential Bill Number)
transferMatchValue: string

Maximum Length: 30

Match Type and Match Value are defaulted based on their values for the payment event that you are transferring. If necessary, modify the values appropriately for the account to which you are transferring the payment event.

Example: 995516242555
transferNonCISComment: string

Maximum Length: 254

Following parameters must be specified in the Payment Event Transfer dialog to transfer a payment - Non CIS Name, Reference Number, and Non CIS Comments. Non CIS Name, Reference Number, and Non CIS Comments appear if the Account ID belongs to a customer class that is used for non-CIS payments.
transferNonCisName: string

Maximum Length: 50

Following parameters must be specified in the Payment Event Transfer dialog to transfer a payment - Non CIS Name, Reference Number, and Non CIS Comments. Non CIS Name, Reference Number, and Non CIS Comments appear if the Account ID belongs to a customer class that is used for non-CIS payments.
transferNonCisReferenceNumber: string

Maximum Length: 30

Following parameters must be specified in the Payment Event Transfer dialog to transfer a payment - Non CIS Name, Reference Number, and Non CIS Comments. Non CIS Name, Reference Number, and Non CIS Comments appear if the Account ID belongs to a customer class that is used for non-CIS payments.
version4: number

Minimum Value: -99999

Maximum Value: 99999

Version

{
    "type":"object",
    "properties":{
        "_self":{
            "type":"string",
            "description":"_self"
        },
        "paymentId":{
            "type":"string",
            "maxLength":"12",
            "description":"Payment ID is the system-assigned unique identifier of the payment.",
            "example":"317896608844"
        },
        "paymentEvent":{
            "type":"object",
            "properties":{
                "paymentEventId":{
                    "type":"string",
                    "maxLength":"12",
                    "description":"Payment Event ID is the system-assigned unique identifier of the payment event.",
                    "example":"317772795000"
                },
                "expMsg2":{
                    "type":"string",
                    "maxLength":"30",
                    "description":"Payment Event ID is the system-assigned unique identifier of the payment event.",
                    "example":"317772795000"
                },
                "_link":{
                    "type":"string",
                    "description":"_link"
                }
            }
        },
        "cancelReason":{
            "type":"string",
            "maxLength":"30",
            "description":"If the payment is canceled, the Cancel Reason is displayed.",
            "example":"Data entry error"
        },
        "currency":{
            "type":"object",
            "properties":{
                "currency4":{
                    "type":"string",
                    "maxLength":"3",
                    "description":"Currency Code"
                },
                "_link":{
                    "type":"string",
                    "description":"_link"
                }
            }
        },
        "account":{
            "type":"object",
            "properties":{
                "accountId2":{
                    "type":"string",
                    "maxLength":"10",
                    "description":"Account ID"
                },
                "_link":{
                    "type":"string",
                    "description":"_link"
                }
            }
        },
        "paymentStatus":{
            "type":"string",
            "enum":[
                "10  ",
                "20  ",
                "30  ",
                "50  ",
                "60  "
            ],
            "description":"Payment Status is the payment's status.\n* `10  ` - Incomplete,\n* `20  ` - Error,\n* `30  ` - Freezable,\n* `50  ` - Frozen,\n* `60  ` - Canceled",
            "example":"30"
        },
        "paymentAmount":{
            "type":"number",
            "description":"Payment Amount is the amount of the payment. This field is gray after the payment is frozen.",
            "example":"300"
        },
        "nonCisName":{
            "type":"string",
            "maxLength":"50",
            "description":"If the payment is linked to an Account ID that belongs to a customer class that is used for non-CIS payments, the following fields appear (note, these fields are gray after the payment is frozen):\n\n    Name is the name of the person remitting the payment.\n    Reference Number is the reference number of the item being paid. For example, the property tax reference number.\n    Comments are used to describe anything unusual about the non-CIS payment.\n\nFor this one I would recommend something such as:\n\nIf the payment is linked to an Account ID that belongs to a customer class that is used for non-CIS payments, the Name defines the name of the person remitting the payment.",
            "example":"ZZMXA,CX_test"
        },
        "nonCisReferenceNumber":{
            "type":"string",
            "maxLength":"30",
            "description":"If the payment is linked to an Account ID that belongs to a customer class that is used for non-CIS payments, the following fields appear (note, these fields are gray after the payment is frozen):\n\n    Name is the name of the person remitting the payment.\n    Reference Number is the reference number of the item being paid. For example, the property tax reference number.\n    Comments are used to describe anything unusual about the non-CIS payment."
        },
        "nonCisComments":{
            "type":"string",
            "maxLength":"254",
            "description":"If the payment is linked to an Account ID that belongs to a customer class that is used for non-CIS payments, the following fields appear (note, these fields are gray after the payment is frozen):\n\n    Name is the name of the person remitting the payment.\n    Reference Number is the reference number of the item being paid. For example, the property tax reference number.\n    Comments are used to describe anything unusual about the non-CIS payment."
        },
        "matchType":{
            "type":"object",
            "description":"Match Type and Match Value will only be used if either of the following conditions is true:\n\n    The Account ID belongs to an open item customer class. In this situation, specify a Match Type to define how the payment should be matched to the customer's open-items and use Match Value to define the open-items covered by the payment\n    The customer wants to restrict the distribution of the payment to a specific service agreement. In this situation, specify a Match Type of \"service agreement ID\" and a Match Value of the respective service agreement ID.\n\nMatch Type and Match Value are gray after the payment is frozen.",
            "properties":{
                "matchType":{
                    "type":"string",
                    "maxLength":"8",
                    "description":"Match Type and Match Value will only be used if either of the following conditions is true:\n\n    The Account ID belongs to an open item customer class. In this situation, specify a Match Type to define how the payment should be matched to the customer's open-items and use Match Value to define the open-items covered by the payment\n    The customer wants to restrict the distribution of the payment to a specific service agreement. In this situation, specify a Match Type of \"service agreement ID\" and a Match Value of the respective service agreement ID.\n\nMatch Type and Match Value are gray after the payment is frozen."
                },
                "_link":{
                    "type":"string",
                    "description":"_link"
                }
            }
        },
        "matchValue":{
            "type":"string",
            "maxLength":"30",
            "description":"Match Type and Match Value will only be used if either of the following conditions is true:\n\n    The Account ID belongs to an open item customer class. In this situation, specify a Match Type to define how the payment should be matched to the customer's open-items and use Match Value to define the open-items covered by the payment\n    The customer wants to restrict the distribution of the payment to a specific service agreement. In this situation, specify a Match Type of \"service agreement ID\" and a Match Value of the respective service agreement ID.\n\nMatch Type and Match Value are gray after the payment is frozen."
        },
        "accountCheckDigit":{
            "type":"string",
            "maxLength":"1",
            "description":"Account Check Digit"
        },
        "paymentAccountCash":{
            "type":"string",
            "maxLength":"30",
            "description":"Use Cash-Only Threshold to define the number of cash-only points a customer must have before the system warns the customer service representative accepting payments that the account is cash-only."
        },
        "isOpenItemAccounting":{
            "type":"boolean",
            "description":"Open Item Accounting Switch",
            "example":"false"
        },
        "isNonCISAccount":{
            "type":"boolean",
            "description":"Non-CIS Account Switch",
            "example":"true"
        },
        "isPayTransfer":{
            "type":"boolean",
            "description":"When Payment Transfer button is clicked, the Payment Event Transfer dialog opens to transfer a payment.",
            "example":"true"
        },
        "transferAccountId":{
            "type":"string",
            "maxLength":"10",
            "description":"Account ID is the account to which the payment event should be transferred."
        },
        "transferNonCisName":{
            "type":"string",
            "maxLength":"50",
            "description":"Following parameters must be specified in the Payment Event Transfer dialog to transfer a payment - Non CIS Name, Reference Number, and Non CIS Comments.\n\nNon CIS Name, Reference Number, and Non CIS Comments appear if the Account ID belongs to a customer class that is used for non-CIS payments."
        },
        "transferNonCisReferenceNumber":{
            "type":"string",
            "maxLength":"30",
            "description":"Following parameters must be specified in the Payment Event Transfer dialog to transfer a payment - Non CIS Name, Reference Number, and Non CIS Comments.\n\nNon CIS Name, Reference Number, and Non CIS Comments appear if the Account ID belongs to a customer class that is used for non-CIS payments."
        },
        "transferNonCISComment":{
            "type":"string",
            "maxLength":"254",
            "description":"Following parameters must be specified in the Payment Event Transfer dialog to transfer a payment - Non CIS Name, Reference Number, and Non CIS Comments.\n\nNon CIS Name, Reference Number, and Non CIS Comments appear if the Account ID belongs to a customer class that is used for non-CIS payments."
        },
        "transferCancelReason":{
            "type":"string",
            "maxLength":"4",
            "description":"Cancel Reason defines why you are performing the payment event transfer.",
            "example":"NSF\n\n(Non sufficient funds)"
        },
        "transferMatchType":{
            "type":"string",
            "maxLength":"8",
            "description":"Match Type and Match Value are defaulted based on their values for the payment event that you are transferring. If necessary, modify the values appropriately for the account to which you are transferring the payment event.",
            "example":"BILL-ID\n\n(Bill ID / Sequential Bill Number)"
        },
        "transferMatchValue":{
            "type":"string",
            "maxLength":"30",
            "description":"Match Type and Match Value are defaulted based on their values for the payment event that you are transferring. If necessary, modify the values appropriately for the account to which you are transferring the payment event.",
            "example":"995516242555"
        },
        "version4":{
            "type":"number",
            "maximum":"99999",
            "minimum":"-99999",
            "description":"Version"
        },
        "paySegments":{
            "type":"object",
            "properties":{
                "paySegments":{
                    "type":"object",
                    "properties":{
                        "paymentId":{
                            "type":"string",
                            "maxLength":"12",
                            "description":"Payment ID is the system-assigned unique identifier of the payment.",
                            "example":"317896608844"
                        },
                        "_link":{
                            "type":"string",
                            "description":"_link"
                        }
                    }
                },
                "count":{
                    "type":"number",
                    "maximum":"99999",
                    "minimum":"0",
                    "description":"Count"
                },
                "distributedAmount":{
                    "type":"number",
                    "description":"Total distributed amount",
                    "example":"75"
                }
            }
        },
        "Exception":{
            "type":"object",
            "properties":{
                "messageCategory":{
                    "type":"object",
                    "description":"Message category within Oracle Utilities Application Framework.",
                    "properties":{
                        "messageCategory":{
                            "type":"number",
                            "maximum":"99999",
                            "minimum":"-99999",
                            "description":"Message category within Oracle Utilities Application Framework.",
                            "example":"11"
                        },
                        "_link":{
                            "type":"string",
                            "description":"_link"
                        }
                    }
                },
                "messageNumber":{
                    "type":"number",
                    "maximum":"99999",
                    "minimum":"-99999",
                    "description":"Message number within Oracle Utilities Application Framework.",
                    "example":"14107"
                },
                "paymentExceptionType":{
                    "type":"string",
                    "enum":[
                        "10  ",
                        "20  ",
                        "30  ",
                        "40  "
                    ],
                    "description":"Payment Exception Type\n* `10  ` - No Payment Segment found,\n* `20  ` - No SA found for this acct.,\n* `30  ` - Unbalanced Payment,\n* `40  ` - Payment in error",
                    "example":"40"
                },
                "expandedMessage":{
                    "type":"string",
                    "maxLength":"254",
                    "description":"Expanded Message exception",
                    "example":"The Payment is incomplete."
                },
                "messageParameter1":{
                    "type":"string",
                    "maxLength":"2000",
                    "description":"Message Parameter"
                },
                "messageParameter2":{
                    "type":"string",
                    "maxLength":"2000",
                    "description":"Message Parameter"
                },
                "messageParameter3":{
                    "type":"string",
                    "maxLength":"2000",
                    "description":"Message Parameter"
                },
                "messageParameter4":{
                    "type":"string",
                    "maxLength":"2000",
                    "description":"Message Parameter"
                },
                "messageParameter5":{
                    "type":"string",
                    "maxLength":"2000",
                    "description":"Message Parameter"
                },
                "messageParameter6":{
                    "type":"string",
                    "maxLength":"2000",
                    "description":"Message Parameter"
                },
                "messageParameter7":{
                    "type":"string",
                    "maxLength":"2000",
                    "description":"Message Parameter"
                },
                "messageParameter8":{
                    "type":"string",
                    "maxLength":"2000",
                    "description":"Message Parameter"
                },
                "messageParameter9":{
                    "type":"string",
                    "maxLength":"2000",
                    "description":"Message Parameter"
                },
                "callingProgramSequence":{
                    "type":"string",
                    "maxLength":"254",
                    "description":"Calling Program Sequence"
                },
                "user":{
                    "type":"object",
                    "description":"User",
                    "properties":{
                        "user":{
                            "type":"string",
                            "maxLength":"8",
                            "description":"User"
                        },
                        "_link":{
                            "type":"string",
                            "description":"_link"
                        }
                    }
                },
                "isReviewed":{
                    "type":"boolean",
                    "description":"Reviewed",
                    "example":"false"
                },
                "reviewUser":{
                    "type":"object",
                    "description":"Review User",
                    "properties":{
                        "reviewUser":{
                            "type":"string",
                            "maxLength":"8",
                            "description":"Review User"
                        },
                        "_link":{
                            "type":"string",
                            "description":"_link"
                        }
                    }
                },
                "reviewedDate":{
                    "type":"string",
                    "format":"date",
                    "description":"Review Date"
                },
                "comments":{
                    "type":"string",
                    "maxLength":"254",
                    "description":"Comments"
                },
                "creationDateTime":{
                    "type":"string",
                    "format":"date-time",
                    "description":"Create Date/Time",
                    "example":"2010-11-24T17:49:23-05:00"
                },
                "version2":{
                    "type":"number",
                    "maximum":"0",
                    "minimum":"0",
                    "description":"The Version number is used for internal concurrency checks.",
                    "example":"1"
                }
            }
        },
        "characteristics":{
            "type":"object",
            "properties":{
                "_data":{
                    "type":"array",
                    "items":{
                        "type":"object",
                        "properties":{
                            "sequence":{
                                "type":"number",
                                "maximum":"999",
                                "minimum":"-999",
                                "description":"Sequence Controls the order in which characteristics of the same type are displayed.",
                                "example":"1"
                            },
                            "characteristicType":{
                                "type":"object",
                                "properties":{
                                    "characteristicType":{
                                        "type":"string",
                                        "maxLength":"8",
                                        "description":"Characteristic Type"
                                    },
                                    "_link":{
                                        "type":"string",
                                        "description":"_link"
                                    }
                                }
                            },
                            "typeOfCharacteristicValue":{
                                "type":"string",
                                "enum":[
                                    "ADV ",
                                    "DFV ",
                                    "FKV ",
                                    "FLV "
                                ],
                                "description":"Characteristic Value indicates the value of the characteristic if the characteristic type is pre-defined or foreign key reference.\n* `ADV ` - Adhoc Value,\n* `DFV ` - Predefined Value,\n* `FKV ` - Foreign Key Value,\n* `FLV ` - File Location Value",
                                "example":"02-20-2008"
                            },
                            "characteristicValue":{
                                "type":"object",
                                "properties":{
                                    "value":{
                                        "type":"string",
                                        "description":"(value)"
                                    },
                                    "value2":{
                                        "type":"string",
                                        "description":"(value2)"
                                    },
                                    "value3":{
                                        "type":"string",
                                        "description":"(value3)"
                                    },
                                    "value4":{
                                        "type":"string",
                                        "description":"(value4)"
                                    },
                                    "value5":{
                                        "type":"string",
                                        "description":"(value5)"
                                    },
                                    "_link":{
                                        "type":"string",
                                        "description":"(_link)"
                                    }
                                }
                            },
                            "version":{
                                "type":"number",
                                "maximum":"99999",
                                "minimum":"-99999",
                                "description":"The Version number is used for internal concurrency checks.",
                                "example":"20"
                            }
                        }
                    }
                }
            }
        },
        "nextActions":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "action":{
                        "type":"string",
                        "enum":[
                            "C1CF",
                            "C1CR",
                            "C1DE",
                            "C1DS",
                            "C1FR",
                            "C1IC",
                            "C1RB",
                            "C1RC",
                            "C1RO",
                            "C1SA",
                            "C1SV",
                            "C1TR",
                            "F1CN",
                            "F1CO",
                            "F1GN"
                        ],
                        "description":"Web Service Action:\n* `C1CF` - Cancel Frozen,\n* `C1CR` - Credit Note,\n* `C1DE` - Delete,\n* `C1DS` - Distribute,\n* `C1FR` - Freeze,\n* `C1IC` - Init Cancel,\n* `C1RB` - Rebill,\n* `C1RC` - Recommend Budget,\n* `C1RO` - ReOpen,\n* `C1SA` - Submit For Approval,\n* `C1SV` - Save,\n* `C1TR` - Transfer,\n* `F1CN` - Cancel,\n* `F1CO` - Complete,\n* `F1GN` - Generate"
                    }
                }
            }
        }
    },
    "xml":{
        "name":"C1-CxPayment"
    }
}

Nested Schema : account

Type: object

Show Source

_link: string

_link
accountId2: string

Maximum Length: 10

Account ID

{
    "type":"object",
    "properties":{
        "accountId2":{
            "type":"string",
            "maxLength":"10",
            "description":"Account ID"
        },
        "_link":{
            "type":"string",
            "description":"_link"
        }
    }
}

Nested Schema : characteristics

Type: object

Show Source

_data: array _data

{
    "type":"object",
    "properties":{
        "_data":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "sequence":{
                        "type":"number",
                        "maximum":"999",
                        "minimum":"-999",
                        "description":"Sequence Controls the order in which characteristics of the same type are displayed.",
                        "example":"1"
                    },
                    "characteristicType":{
                        "type":"object",
                        "properties":{
                            "characteristicType":{
                                "type":"string",
                                "maxLength":"8",
                                "description":"Characteristic Type"
                            },
                            "_link":{
                                "type":"string",
                                "description":"_link"
                            }
                        }
                    },
                    "typeOfCharacteristicValue":{
                        "type":"string",
                        "enum":[
                            "ADV ",
                            "DFV ",
                            "FKV ",
                            "FLV "
                        ],
                        "description":"Characteristic Value indicates the value of the characteristic if the characteristic type is pre-defined or foreign key reference.\n* `ADV ` - Adhoc Value,\n* `DFV ` - Predefined Value,\n* `FKV ` - Foreign Key Value,\n* `FLV ` - File Location Value",
                        "example":"02-20-2008"
                    },
                    "characteristicValue":{
                        "type":"object",
                        "properties":{
                            "value":{
                                "type":"string",
                                "description":"(value)"
                            },
                            "value2":{
                                "type":"string",
                                "description":"(value2)"
                            },
                            "value3":{
                                "type":"string",
                                "description":"(value3)"
                            },
                            "value4":{
                                "type":"string",
                                "description":"(value4)"
                            },
                            "value5":{
                                "type":"string",
                                "description":"(value5)"
                            },
                            "_link":{
                                "type":"string",
                                "description":"(_link)"
                            }
                        }
                    },
                    "version":{
                        "type":"number",
                        "maximum":"99999",
                        "minimum":"-99999",
                        "description":"The Version number is used for internal concurrency checks.",
                        "example":"20"
                    }
                }
            }
        }
    }
}

Nested Schema : currency

Type: object

Show Source

_link: string

_link
currency4: string

Maximum Length: 3

Currency Code

{
    "type":"object",
    "properties":{
        "currency4":{
            "type":"string",
            "maxLength":"3",
            "description":"Currency Code"
        },
        "_link":{
            "type":"string",
            "description":"_link"
        }
    }
}

Nested Schema : Exception

Type: object

Show Source

callingProgramSequence: string

Maximum Length: 254

Calling Program Sequence
comments: string

Maximum Length: 254

Comments
creationDateTime: string (date-time)

Create Date/Time

Example: 2010-11-24T17:49:23-05:00
expandedMessage: string

Maximum Length: 254

Expanded Message exception

Example: The Payment is incomplete.
isReviewed: boolean

Reviewed

Example: false
messageCategory: object messageCategory

Message category within Oracle Utilities Application Framework.
messageNumber: number

Minimum Value: -99999

Maximum Value: 99999

Message number within Oracle Utilities Application Framework.

Example: 14107
messageParameter1: string

Maximum Length: 2000

Message Parameter
messageParameter2: string

Maximum Length: 2000

Message Parameter
messageParameter3: string

Maximum Length: 2000

Message Parameter
messageParameter4: string

Maximum Length: 2000

Message Parameter
messageParameter5: string

Maximum Length: 2000

Message Parameter
messageParameter6: string

Maximum Length: 2000

Message Parameter
messageParameter7: string

Maximum Length: 2000

Message Parameter
messageParameter8: string

Maximum Length: 2000

Message Parameter
messageParameter9: string

Maximum Length: 2000

Message Parameter
paymentExceptionType: string

Allowed Values: [ "10 ", "20 ", "30 ", "40 " ]

Payment Exception Type * `10 ` - No Payment Segment found, * `20 ` - No SA found for this acct., * `30 ` - Unbalanced Payment, * `40 ` - Payment in error

Example: 40
reviewedDate: string (date)

Review Date
reviewUser: object reviewUser

Review User
user: object user

User
version2: number

Minimum Value: 0

Maximum Value: 0

The Version number is used for internal concurrency checks.

Example: 1

{
    "type":"object",
    "properties":{
        "messageCategory":{
            "type":"object",
            "description":"Message category within Oracle Utilities Application Framework.",
            "properties":{
                "messageCategory":{
                    "type":"number",
                    "maximum":"99999",
                    "minimum":"-99999",
                    "description":"Message category within Oracle Utilities Application Framework.",
                    "example":"11"
                },
                "_link":{
                    "type":"string",
                    "description":"_link"
                }
            }
        },
        "messageNumber":{
            "type":"number",
            "maximum":"99999",
            "minimum":"-99999",
            "description":"Message number within Oracle Utilities Application Framework.",
            "example":"14107"
        },
        "paymentExceptionType":{
            "type":"string",
            "enum":[
                "10  ",
                "20  ",
                "30  ",
                "40  "
            ],
            "description":"Payment Exception Type\n* `10  ` - No Payment Segment found,\n* `20  ` - No SA found for this acct.,\n* `30  ` - Unbalanced Payment,\n* `40  ` - Payment in error",
            "example":"40"
        },
        "expandedMessage":{
            "type":"string",
            "maxLength":"254",
            "description":"Expanded Message exception",
            "example":"The Payment is incomplete."
        },
        "messageParameter1":{
            "type":"string",
            "maxLength":"2000",
            "description":"Message Parameter"
        },
        "messageParameter2":{
            "type":"string",
            "maxLength":"2000",
            "description":"Message Parameter"
        },
        "messageParameter3":{
            "type":"string",
            "maxLength":"2000",
            "description":"Message Parameter"
        },
        "messageParameter4":{
            "type":"string",
            "maxLength":"2000",
            "description":"Message Parameter"
        },
        "messageParameter5":{
            "type":"string",
            "maxLength":"2000",
            "description":"Message Parameter"
        },
        "messageParameter6":{
            "type":"string",
            "maxLength":"2000",
            "description":"Message Parameter"
        },
        "messageParameter7":{
            "type":"string",
            "maxLength":"2000",
            "description":"Message Parameter"
        },
        "messageParameter8":{
            "type":"string",
            "maxLength":"2000",
            "description":"Message Parameter"
        },
        "messageParameter9":{
            "type":"string",
            "maxLength":"2000",
            "description":"Message Parameter"
        },
        "callingProgramSequence":{
            "type":"string",
            "maxLength":"254",
            "description":"Calling Program Sequence"
        },
        "user":{
            "type":"object",
            "description":"User",
            "properties":{
                "user":{
                    "type":"string",
                    "maxLength":"8",
                    "description":"User"
                },
                "_link":{
                    "type":"string",
                    "description":"_link"
                }
            }
        },
        "isReviewed":{
            "type":"boolean",
            "description":"Reviewed",
            "example":"false"
        },
        "reviewUser":{
            "type":"object",
            "description":"Review User",
            "properties":{
                "reviewUser":{
                    "type":"string",
                    "maxLength":"8",
                    "description":"Review User"
                },
                "_link":{
                    "type":"string",
                    "description":"_link"
                }
            }
        },
        "reviewedDate":{
            "type":"string",
            "format":"date",
            "description":"Review Date"
        },
        "comments":{
            "type":"string",
            "maxLength":"254",
            "description":"Comments"
        },
        "creationDateTime":{
            "type":"string",
            "format":"date-time",
            "description":"Create Date/Time",
            "example":"2010-11-24T17:49:23-05:00"
        },
        "version2":{
            "type":"number",
            "maximum":"0",
            "minimum":"0",
            "description":"The Version number is used for internal concurrency checks.",
            "example":"1"
        }
    }
}

Nested Schema : matchType

Type: object

Match Type and Match Value will only be used if either of the following conditions is true: The Account ID belongs to an open item customer class. In this situation, specify a Match Type to define how the payment should be matched to the customer's open-items and use Match Value to define the open-items covered by the payment The customer wants to restrict the distribution of the payment to a specific service agreement. In this situation, specify a Match Type of "service agreement ID" and a Match Value of the respective service agreement ID. Match Type and Match Value are gray after the payment is frozen.

Show Source

_link: string

_link
matchType: string

Maximum Length: 8

Match Type and Match Value will only be used if either of the following conditions is true: The Account ID belongs to an open item customer class. In this situation, specify a Match Type to define how the payment should be matched to the customer's open-items and use Match Value to define the open-items covered by the payment The customer wants to restrict the distribution of the payment to a specific service agreement. In this situation, specify a Match Type of "service agreement ID" and a Match Value of the respective service agreement ID. Match Type and Match Value are gray after the payment is frozen.

{
    "type":"object",
    "description":"Match Type and Match Value will only be used if either of the following conditions is true:\n\n    The Account ID belongs to an open item customer class. In this situation, specify a Match Type to define how the payment should be matched to the customer's open-items and use Match Value to define the open-items covered by the payment\n    The customer wants to restrict the distribution of the payment to a specific service agreement. In this situation, specify a Match Type of \"service agreement ID\" and a Match Value of the respective service agreement ID.\n\nMatch Type and Match Value are gray after the payment is frozen.",
    "properties":{
        "matchType":{
            "type":"string",
            "maxLength":"8",
            "description":"Match Type and Match Value will only be used if either of the following conditions is true:\n\n    The Account ID belongs to an open item customer class. In this situation, specify a Match Type to define how the payment should be matched to the customer's open-items and use Match Value to define the open-items covered by the payment\n    The customer wants to restrict the distribution of the payment to a specific service agreement. In this situation, specify a Match Type of \"service agreement ID\" and a Match Value of the respective service agreement ID.\n\nMatch Type and Match Value are gray after the payment is frozen."
        },
        "_link":{
            "type":"string",
            "description":"_link"
        }
    }
}

Nested Schema : nextActions

Type: array

Show Source

Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "action":{
                "type":"string",
                "enum":[
                    "C1CF",
                    "C1CR",
                    "C1DE",
                    "C1DS",
                    "C1FR",
                    "C1IC",
                    "C1RB",
                    "C1RC",
                    "C1RO",
                    "C1SA",
                    "C1SV",
                    "C1TR",
                    "F1CN",
                    "F1CO",
                    "F1GN"
                ],
                "description":"Web Service Action:\n* `C1CF` - Cancel Frozen,\n* `C1CR` - Credit Note,\n* `C1DE` - Delete,\n* `C1DS` - Distribute,\n* `C1FR` - Freeze,\n* `C1IC` - Init Cancel,\n* `C1RB` - Rebill,\n* `C1RC` - Recommend Budget,\n* `C1RO` - ReOpen,\n* `C1SA` - Submit For Approval,\n* `C1SV` - Save,\n* `C1TR` - Transfer,\n* `F1CN` - Cancel,\n* `F1CO` - Complete,\n* `F1GN` - Generate"
            }
        }
    }
}

Nested Schema : paymentEvent

Type: object

Show Source

_link: string

_link
expMsg2: string

Maximum Length: 30

Payment Event ID is the system-assigned unique identifier of the payment event.

Example: 317772795000
paymentEventId: string

Maximum Length: 12

Payment Event ID is the system-assigned unique identifier of the payment event.

Example: 317772795000

{
    "type":"object",
    "properties":{
        "paymentEventId":{
            "type":"string",
            "maxLength":"12",
            "description":"Payment Event ID is the system-assigned unique identifier of the payment event.",
            "example":"317772795000"
        },
        "expMsg2":{
            "type":"string",
            "maxLength":"30",
            "description":"Payment Event ID is the system-assigned unique identifier of the payment event.",
            "example":"317772795000"
        },
        "_link":{
            "type":"string",
            "description":"_link"
        }
    }
}

Nested Schema : paySegments

Type: object

Show Source

count: number

Minimum Value: 0

Maximum Value: 99999

Count
distributedAmount: number

Total distributed amount

Example: 75
paySegments: object paySegments

{
    "type":"object",
    "properties":{
        "paySegments":{
            "type":"object",
            "properties":{
                "paymentId":{
                    "type":"string",
                    "maxLength":"12",
                    "description":"Payment ID is the system-assigned unique identifier of the payment.",
                    "example":"317896608844"
                },
                "_link":{
                    "type":"string",
                    "description":"_link"
                }
            }
        },
        "count":{
            "type":"number",
            "maximum":"99999",
            "minimum":"0",
            "description":"Count"
        },
        "distributedAmount":{
            "type":"number",
            "description":"Total distributed amount",
            "example":"75"
        }
    }
}

Nested Schema : _data

Type: array

Show Source

Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "sequence":{
                "type":"number",
                "maximum":"999",
                "minimum":"-999",
                "description":"Sequence Controls the order in which characteristics of the same type are displayed.",
                "example":"1"
            },
            "characteristicType":{
                "type":"object",
                "properties":{
                    "characteristicType":{
                        "type":"string",
                        "maxLength":"8",
                        "description":"Characteristic Type"
                    },
                    "_link":{
                        "type":"string",
                        "description":"_link"
                    }
                }
            },
            "typeOfCharacteristicValue":{
                "type":"string",
                "enum":[
                    "ADV ",
                    "DFV ",
                    "FKV ",
                    "FLV "
                ],
                "description":"Characteristic Value indicates the value of the characteristic if the characteristic type is pre-defined or foreign key reference.\n* `ADV ` - Adhoc Value,\n* `DFV ` - Predefined Value,\n* `FKV ` - Foreign Key Value,\n* `FLV ` - File Location Value",
                "example":"02-20-2008"
            },
            "characteristicValue":{
                "type":"object",
                "properties":{
                    "value":{
                        "type":"string",
                        "description":"(value)"
                    },
                    "value2":{
                        "type":"string",
                        "description":"(value2)"
                    },
                    "value3":{
                        "type":"string",
                        "description":"(value3)"
                    },
                    "value4":{
                        "type":"string",
                        "description":"(value4)"
                    },
                    "value5":{
                        "type":"string",
                        "description":"(value5)"
                    },
                    "_link":{
                        "type":"string",
                        "description":"(_link)"
                    }
                }
            },
            "version":{
                "type":"number",
                "maximum":"99999",
                "minimum":"-99999",
                "description":"The Version number is used for internal concurrency checks.",
                "example":"20"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

characteristicType: object characteristicType
characteristicValue: object characteristicValue
sequence: number

Minimum Value: -999

Maximum Value: 999

Sequence Controls the order in which characteristics of the same type are displayed.

Example: 1
typeOfCharacteristicValue: string

Allowed Values: [ "ADV ", "DFV ", "FKV ", "FLV " ]

Characteristic Value indicates the value of the characteristic if the characteristic type is pre-defined or foreign key reference. * `ADV ` - Adhoc Value, * `DFV ` - Predefined Value, * `FKV ` - Foreign Key Value, * `FLV ` - File Location Value

Example: 02-20-2008
version: number

Minimum Value: -99999

Maximum Value: 99999

The Version number is used for internal concurrency checks.

Example: 20

{
    "type":"object",
    "properties":{
        "sequence":{
            "type":"number",
            "maximum":"999",
            "minimum":"-999",
            "description":"Sequence Controls the order in which characteristics of the same type are displayed.",
            "example":"1"
        },
        "characteristicType":{
            "type":"object",
            "properties":{
                "characteristicType":{
                    "type":"string",
                    "maxLength":"8",
                    "description":"Characteristic Type"
                },
                "_link":{
                    "type":"string",
                    "description":"_link"
                }
            }
        },
        "typeOfCharacteristicValue":{
            "type":"string",
            "enum":[
                "ADV ",
                "DFV ",
                "FKV ",
                "FLV "
            ],
            "description":"Characteristic Value indicates the value of the characteristic if the characteristic type is pre-defined or foreign key reference.\n* `ADV ` - Adhoc Value,\n* `DFV ` - Predefined Value,\n* `FKV ` - Foreign Key Value,\n* `FLV ` - File Location Value",
            "example":"02-20-2008"
        },
        "characteristicValue":{
            "type":"object",
            "properties":{
                "value":{
                    "type":"string",
                    "description":"(value)"
                },
                "value2":{
                    "type":"string",
                    "description":"(value2)"
                },
                "value3":{
                    "type":"string",
                    "description":"(value3)"
                },
                "value4":{
                    "type":"string",
                    "description":"(value4)"
                },
                "value5":{
                    "type":"string",
                    "description":"(value5)"
                },
                "_link":{
                    "type":"string",
                    "description":"(_link)"
                }
            }
        },
        "version":{
            "type":"number",
            "maximum":"99999",
            "minimum":"-99999",
            "description":"The Version number is used for internal concurrency checks.",
            "example":"20"
        }
    }
}

Nested Schema : characteristicType

Type: object

Show Source

_link: string

_link
characteristicType: string

Maximum Length: 8

Characteristic Type

{
    "type":"object",
    "properties":{
        "characteristicType":{
            "type":"string",
            "maxLength":"8",
            "description":"Characteristic Type"
        },
        "_link":{
            "type":"string",
            "description":"_link"
        }
    }
}

Nested Schema : characteristicValue

Type: object

Show Source

_link: string

(_link)
value: string

(value)
value2: string

(value2)
value3: string

(value3)
value4: string

(value4)
value5: string

(value5)

{
    "type":"object",
    "properties":{
        "value":{
            "type":"string",
            "description":"(value)"
        },
        "value2":{
            "type":"string",
            "description":"(value2)"
        },
        "value3":{
            "type":"string",
            "description":"(value3)"
        },
        "value4":{
            "type":"string",
            "description":"(value4)"
        },
        "value5":{
            "type":"string",
            "description":"(value5)"
        },
        "_link":{
            "type":"string",
            "description":"(_link)"
        }
    }
}

Nested Schema : messageCategory

Type: object

Message category within Oracle Utilities Application Framework.

Show Source

_link: string

_link
messageCategory: number

Minimum Value: -99999

Maximum Value: 99999

Message category within Oracle Utilities Application Framework.

Example: 11

{
    "type":"object",
    "description":"Message category within Oracle Utilities Application Framework.",
    "properties":{
        "messageCategory":{
            "type":"number",
            "maximum":"99999",
            "minimum":"-99999",
            "description":"Message category within Oracle Utilities Application Framework.",
            "example":"11"
        },
        "_link":{
            "type":"string",
            "description":"_link"
        }
    }
}

Nested Schema : reviewUser

Type: object

Review User

Show Source

_link: string

_link
reviewUser: string

Maximum Length: 8

Review User

{
    "type":"object",
    "description":"Review User",
    "properties":{
        "reviewUser":{
            "type":"string",
            "maxLength":"8",
            "description":"Review User"
        },
        "_link":{
            "type":"string",
            "description":"_link"
        }
    }
}

Nested Schema : user

Type: object

User

Show Source

_link: string

_link
user: string

Maximum Length: 8

User

{
    "type":"object",
    "description":"User",
    "properties":{
        "user":{
            "type":"string",
            "maxLength":"8",
            "description":"User"
        },
        "_link":{
            "type":"string",
            "description":"_link"
        }
    }
}

Nested Schema : items

Type: object

Show Source

action: string

Allowed Values: [ "C1CF", "C1CR", "C1DE", "C1DS", "C1FR", "C1IC", "C1RB", "C1RC", "C1RO", "C1SA", "C1SV", "C1TR", "F1CN", "F1CO", "F1GN" ]

Web Service Action: * `C1CF` - Cancel Frozen, * `C1CR` - Credit Note, * `C1DE` - Delete, * `C1DS` - Distribute, * `C1FR` - Freeze, * `C1IC` - Init Cancel, * `C1RB` - Rebill, * `C1RC` - Recommend Budget, * `C1RO` - ReOpen, * `C1SA` - Submit For Approval, * `C1SV` - Save, * `C1TR` - Transfer, * `F1CN` - Cancel, * `F1CO` - Complete, * `F1GN` - Generate

{
    "type":"object",
    "properties":{
        "action":{
            "type":"string",
            "enum":[
                "C1CF",
                "C1CR",
                "C1DE",
                "C1DS",
                "C1FR",
                "C1IC",
                "C1RB",
                "C1RC",
                "C1RO",
                "C1SA",
                "C1SV",
                "C1TR",
                "F1CN",
                "F1CO",
                "F1GN"
            ],
            "description":"Web Service Action:\n* `C1CF` - Cancel Frozen,\n* `C1CR` - Credit Note,\n* `C1DE` - Delete,\n* `C1DS` - Distribute,\n* `C1FR` - Freeze,\n* `C1IC` - Init Cancel,\n* `C1RB` - Rebill,\n* `C1RC` - Recommend Budget,\n* `C1RO` - ReOpen,\n* `C1SA` - Submit For Approval,\n* `C1SV` - Save,\n* `C1TR` - Transfer,\n* `F1CN` - Cancel,\n* `F1CO` - Complete,\n* `F1GN` - Generate"
        }
    }
}

Nested Schema : paySegments

Type: object

Show Source

_link: string

_link
paymentId: string

Maximum Length: 12

Payment ID is the system-assigned unique identifier of the payment.

Example: 317896608844

{
    "type":"object",
    "properties":{
        "paymentId":{
            "type":"string",
            "maxLength":"12",
            "description":"Payment ID is the system-assigned unique identifier of the payment.",
            "example":"317896608844"
        },
        "_link":{
            "type":"string",
            "description":"_link"
        }
    }
}

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