Oracle Utilities REST API for Metering and Customer Information

Get Pay Plan

get

/rest/apis/customer/financials/payPlans/{payPlanId}

Request

Path Parameters

payPlanId(required): string
Pay Plan ID is a system-assigned random number that stays with the pay plan for life.
Example:
```
4444444444
```

There's no request body for this operation.

Response

Supported Media Types

application/xml
application/json

200 Response

Success response

Root Schema : C1PayPlan

Type: object

Show Source

_self: string

_self
account: object account
cancelReasonFlag: string

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

Cancel Reason describes how the pay plan was cancelled . * `10 ` - Canceled by System, * `20 ` - Canceled by User

Example: 10
comments: string

Maximum Length: 254

Comments describe any special notes about the pay plan.
createdBy: object createdBy
creationDateTime: string (date-time)

Create Date/Time describes the date and time on which the pay plan was created.

Example: 2009-10-05T00:22:06-04:00
currentBalance: number

The account's Current Balance for the debt class whose debt is insulated by the pay plan.

Example: -75.00
debtClassDescription: string

Maximum Length: 30

Description for the debt class.

Example: Payment arrangement
delinquentDebt: number

Delinquent Amount is the amount of the customer's debt that was due on or before the prior bill's due date.

Example: 0.00
isThirdPartyGuarantor: boolean

Define Third Party Guarantor as true if the person is a third party guarantor of the account's debt. This is defined as false if the person is the Main Customer.

Example: true
lastStatusDateTime: string (date-time)

Last Status Date/Time describes the date and time on which the pay plan was changed.

Example: 2009-10-07T01:47:04-04:00
lastUpdatedBy: object lastUpdatedBy

Last Updated by displays the id of the user who last modified the pay plan.
payMethod: object payMethod
payorAccountId: object payorAccountId

Payor Account Id contains the account ID and name of the person responsible for making the pay plan's payments.
payPlanId: string

Maximum Length: 10

Pay Plan ID is a system-assigned random number that stays with the pay plan for life.

Example: 4444444444
payPlanType: object payPlanType
scheduledPayments: object scheduledPayments
startDate: string (date)

Start Date defines the first day on which the pay plan is tracked, and defaults to the current date.

Example: 2009-08-20
status: string

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

The Status displays the status of the pay plan. * `20 ` - Active, * `30 ` - Canceled, * `40 ` - Broken, * `50 ` - Kept

Example: 20
thirdPartyPayor: object thirdPartyPayor

If a third party is responsible for the pay plan's payment, Third Party Payor must be checked, and the associated third party selected.
totalAmount: number

The Total Amount of the pay plan's scheduled payments.

Example: 100
version: number

Minimum Value: -99999

Maximum Value: 99999

The Version number is used for internal concurrency checks.

Example: 2

{
    "type":"object",
    "properties":{
        "_self":{
            "type":"string",
            "description":"_self"
        },
        "payPlanId":{
            "type":"string",
            "maxLength":10,
            "description":"Pay Plan ID is a system-assigned random number that stays with the pay plan for life.",
            "example":"4444444444"
        },
        "account":{
            "type":"object",
            "properties":{
                "accountId":{
                    "type":"string",
                    "maxLength":10,
                    "description":"Account ID"
                },
                "_link":{
                    "type":"string",
                    "description":"_link"
                }
            }
        },
        "comments":{
            "type":"string",
            "maxLength":254,
            "description":"Comments describe any special notes about the pay plan."
        },
        "creationDateTime":{
            "type":"string",
            "format":"date-time",
            "description":"Create Date/Time describes the date and time on which the pay plan was created.",
            "example":"2009-10-05T00:22:06-04:00"
        },
        "lastStatusDateTime":{
            "type":"string",
            "format":"date-time",
            "description":"Last Status Date/Time describes the date and time on which the pay plan was changed.",
            "example":"2009-10-07T01:47:04-04:00"
        },
        "lastUpdatedBy":{
            "type":"object",
            "description":"Last Updated by displays the id of the user who last modified the pay plan.",
            "properties":{
                "lastUpdatedBy":{
                    "type":"string",
                    "maxLength":8,
                    "description":"User"
                },
                "_link":{
                    "type":"string",
                    "description":"_link"
                }
            }
        },
        "payorAccountId":{
            "type":"object",
            "description":"Payor Account Id contains the account ID and name of the person responsible for making the pay plan's payments.",
            "properties":{
                "payorAccountId":{
                    "type":"string",
                    "maxLength":10,
                    "description":"Payor Account Id contains the account ID and name of the person responsible for making the pay plan's payments.",
                    "example":"4000060000"
                },
                "_link":{
                    "type":"string",
                    "description":"_link"
                }
            }
        },
        "payMethod":{
            "type":"object",
            "properties":{
                "paymentMethod":{
                    "type":"string",
                    "maxLength":10,
                    "description":"Pay Method"
                },
                "_link":{
                    "type":"string",
                    "description":"_link"
                }
            }
        },
        "cancelReasonFlag":{
            "type":"string",
            "enum":[
                "10  ",
                "20  "
            ],
            "description":"Cancel Reason describes how the pay plan was cancelled .\n* `10  ` - Canceled by System,\n* `20  ` - Canceled by User",
            "example":"10"
        },
        "status":{
            "type":"string",
            "enum":[
                "20  ",
                "30  ",
                "40  ",
                "50  "
            ],
            "description":"The Status displays the status of the pay plan.\n* `20  ` - Active,\n* `30  ` - Canceled,\n* `40  ` - Broken,\n* `50  ` - Kept",
            "example":"20"
        },
        "payPlanType":{
            "type":"object",
            "properties":{
                "paymentPlanType":{
                    "type":"string",
                    "maxLength":12,
                    "description":"Pay Plan Type"
                },
                "_link":{
                    "type":"string",
                    "description":"_link"
                }
            }
        },
        "startDate":{
            "type":"string",
            "format":"date",
            "description":"Start Date defines the first day on which the pay plan is tracked, and defaults to the current date.",
            "example":"2009-08-20"
        },
        "debtClassDescription":{
            "type":"string",
            "maxLength":30,
            "description":"Description for the debt class.",
            "example":"Payment arrangement"
        },
        "currentBalance":{
            "type":"number",
            "description":"The account's Current Balance for the debt class whose debt is insulated by the pay plan.",
            "example":"-75.00"
        },
        "delinquentDebt":{
            "type":"number",
            "description":"Delinquent Amount is the amount of the customer's debt that was due on or before the prior bill's due date.",
            "example":"0.00"
        },
        "thirdPartyPayor":{
            "type":"object",
            "description":"If a third party is responsible for the pay plan's payment, Third Party Payor must be checked, and the associated third party selected.",
            "properties":{
                "thirdPartyPayor":{
                    "type":"string",
                    "maxLength":12,
                    "description":"Third Party Payor"
                },
                "_link":{
                    "type":"string",
                    "description":"_link"
                }
            }
        },
        "isThirdPartyGuarantor":{
            "type":"boolean",
            "description":"Define Third Party Guarantor as true if the person is a third party guarantor of the account's debt. This is defined as false if the person is the Main Customer.",
            "example":"true"
        },
        "totalAmount":{
            "type":"number",
            "description":"The Total Amount of the pay plan's scheduled payments.",
            "example":"100"
        },
        "createdBy":{
            "type":"object",
            "properties":{
                "user":{
                    "type":"string",
                    "maxLength":8,
                    "description":"User"
                },
                "_link":{
                    "type":"string",
                    "description":"_link"
                }
            }
        },
        "version":{
            "type":"number",
            "maximum":99999,
            "minimum":-99999,
            "description":"The Version number is used for internal concurrency checks.",
            "example":"2"
        },
        "scheduledPayments":{
            "type":"object",
            "properties":{
                "_data":{
                    "type":"array",
                    "items":{
                        "type":"object",
                        "properties":{
                            "payPlanId":{
                                "type":"string",
                                "maxLength":10,
                                "description":"Pay Plan ID"
                            },
                            "scheduledDate":{
                                "type":"string",
                                "format":"date",
                                "description":"The Scheduled Date for pay plan's scheduled payments.",
                                "example":"2009-10-08"
                            },
                            "scheduledAmount":{
                                "type":"number",
                                "description":"Scheduled Amount for pay plan's scheduled payments.",
                                "example":"75.00"
                            },
                            "autopayClearingId":{
                                "type":"string",
                                "maxLength":12,
                                "description":"Autopay Clearing ID"
                            },
                            "version":{
                                "type":"number",
                                "maximum":99999,
                                "minimum":-99999,
                                "description":"Version"
                            }
                        }
                    }
                }
            }
        }
    },
    "xml":{
        "name":"C1PayPlan"
    }
}

Nested Schema : account

Type: object

Show Source

_link: string

_link
accountId: string

Maximum Length: 10

Account ID

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

Nested Schema : createdBy

Type: object

Show Source

_link: string

_link
user: string

Maximum Length: 8

User

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

Nested Schema : lastUpdatedBy

Type: object

Last Updated by displays the id of the user who last modified the pay plan.

Show Source

_link: string

_link
lastUpdatedBy: string

Maximum Length: 8

User

{
    "type":"object",
    "description":"Last Updated by displays the id of the user who last modified the pay plan.",
    "properties":{
        "lastUpdatedBy":{
            "type":"string",
            "maxLength":8,
            "description":"User"
        },
        "_link":{
            "type":"string",
            "description":"_link"
        }
    }
}

Nested Schema : payMethod

Type: object

Show Source

_link: string

_link
paymentMethod: string

Maximum Length: 10

Pay Method

{
    "type":"object",
    "properties":{
        "paymentMethod":{
            "type":"string",
            "maxLength":10,
            "description":"Pay Method"
        },
        "_link":{
            "type":"string",
            "description":"_link"
        }
    }
}

Nested Schema : payorAccountId

Type: object

Payor Account Id contains the account ID and name of the person responsible for making the pay plan's payments.

Show Source

_link: string

_link
payorAccountId: string

Maximum Length: 10

Payor Account Id contains the account ID and name of the person responsible for making the pay plan's payments.

Example: 4000060000

{
    "type":"object",
    "description":"Payor Account Id contains the account ID and name of the person responsible for making the pay plan's payments.",
    "properties":{
        "payorAccountId":{
            "type":"string",
            "maxLength":10,
            "description":"Payor Account Id contains the account ID and name of the person responsible for making the pay plan's payments.",
            "example":"4000060000"
        },
        "_link":{
            "type":"string",
            "description":"_link"
        }
    }
}

Nested Schema : payPlanType

Type: object

Show Source

_link: string

_link
paymentPlanType: string

Maximum Length: 12

Pay Plan Type

{
    "type":"object",
    "properties":{
        "paymentPlanType":{
            "type":"string",
            "maxLength":12,
            "description":"Pay Plan Type"
        },
        "_link":{
            "type":"string",
            "description":"_link"
        }
    }
}

Nested Schema : scheduledPayments

Type: object

Show Source

_data: array _data

{
    "type":"object",
    "properties":{
        "_data":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "payPlanId":{
                        "type":"string",
                        "maxLength":10,
                        "description":"Pay Plan ID"
                    },
                    "scheduledDate":{
                        "type":"string",
                        "format":"date",
                        "description":"The Scheduled Date for pay plan's scheduled payments.",
                        "example":"2009-10-08"
                    },
                    "scheduledAmount":{
                        "type":"number",
                        "description":"Scheduled Amount for pay plan's scheduled payments.",
                        "example":"75.00"
                    },
                    "autopayClearingId":{
                        "type":"string",
                        "maxLength":12,
                        "description":"Autopay Clearing ID"
                    },
                    "version":{
                        "type":"number",
                        "maximum":99999,
                        "minimum":-99999,
                        "description":"Version"
                    }
                }
            }
        }
    }
}

Nested Schema : thirdPartyPayor

Type: object

If a third party is responsible for the pay plan's payment, Third Party Payor must be checked, and the associated third party selected.

Show Source

_link: string

_link
thirdPartyPayor: string

Maximum Length: 12

Third Party Payor

{
    "type":"object",
    "description":"If a third party is responsible for the pay plan's payment, Third Party Payor must be checked, and the associated third party selected.",
    "properties":{
        "thirdPartyPayor":{
            "type":"string",
            "maxLength":12,
            "description":"Third Party Payor"
        },
        "_link":{
            "type":"string",
            "description":"_link"
        }
    }
}

Nested Schema : _data

Type: array

Show Source

Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "payPlanId":{
                "type":"string",
                "maxLength":10,
                "description":"Pay Plan ID"
            },
            "scheduledDate":{
                "type":"string",
                "format":"date",
                "description":"The Scheduled Date for pay plan's scheduled payments.",
                "example":"2009-10-08"
            },
            "scheduledAmount":{
                "type":"number",
                "description":"Scheduled Amount for pay plan's scheduled payments.",
                "example":"75.00"
            },
            "autopayClearingId":{
                "type":"string",
                "maxLength":12,
                "description":"Autopay Clearing ID"
            },
            "version":{
                "type":"number",
                "maximum":99999,
                "minimum":-99999,
                "description":"Version"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

autopayClearingId: string

Maximum Length: 12

Autopay Clearing ID
payPlanId: string

Maximum Length: 10

Pay Plan ID
scheduledAmount: number

Scheduled Amount for pay plan's scheduled payments.

Example: 75.00
scheduledDate: string (date)

The Scheduled Date for pay plan's scheduled payments.

Example: 2009-10-08
version: number

Minimum Value: -99999

Maximum Value: 99999

Version

{
    "type":"object",
    "properties":{
        "payPlanId":{
            "type":"string",
            "maxLength":10,
            "description":"Pay Plan ID"
        },
        "scheduledDate":{
            "type":"string",
            "format":"date",
            "description":"The Scheduled Date for pay plan's scheduled payments.",
            "example":"2009-10-08"
        },
        "scheduledAmount":{
            "type":"number",
            "description":"Scheduled Amount for pay plan's scheduled payments.",
            "example":"75.00"
        },
        "autopayClearingId":{
            "type":"string",
            "maxLength":12,
            "description":"Autopay Clearing ID"
        },
        "version":{
            "type":"number",
            "maximum":99999,
            "minimum":-99999,
            "description":"Version"
        }
    }
}

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