Get Pay Plan
get
https://server:port/spl/rest/apis/customer/financials/payPlans/{payPlanId}
Request
Path Parameters
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/xml
- application/json
200 Response
Success response
Root Schema : C1PayPlan
Type:
Show Source
object
-
_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 UserExample: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 ` - KeptExample: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
Nested Schema : account
Type:
Show Source
object
-
_link: string
_link
-
accountId: string
Maximum Length:
10
Account ID
Nested Schema : createdBy
Type:
Show Source
object
-
_link: string
_link
-
userId: string
Maximum Length:
8
User
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
-
userId: string
Maximum Length:
8
User
Nested Schema : payMethod
Type:
Show Source
object
-
_link: string
_link
-
payMethod: string
Maximum Length:
10
Pay Method
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
Nested Schema : payPlanType
Type:
Show Source
object
-
_link: string
_link
-
payPlanType: string
Maximum Length:
12
Pay Plan Type
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
Nested Schema : items
Type:
Show Source
object
-
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
400 Response
Bad Request
Root Schema : problemDetailDocument
Type:
Show Source
object
-
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.
Nested Schema : serverMessage
Type:
Show Source
object
-
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.
500 Response
Internal Server Error
Root Schema : problemDetailDocument
Type:
Show Source
object
-
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.
Nested Schema : serverMessage
Type:
Show Source
object
-
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.