Create Overdue Process
post
https://server:port/spl/rest/apis/customer/collections/overdueProcesses/
Request
There are no request parameters for this operation.
Supported Media Types
- application/xml
- application/json
Root Schema : schema
Type:
Show Source
object
-
account: object
account
-
baseDate: string
(date)
Base Date is reserved for future releases. This field is protected when the overdue process is Inactive.Example:
2004-03-01
-
collectingOn: object
collectingOn
-
events: object
events
-
longComments: string
Maximum Length:
2000
Enter any Comments about the overdue process. This field is protected when the overdue process is Inactive. -
name: string
(name)
-
overdueProcessId: string
Maximum Length:
12
Overdue Process ID is the system-assigned unique identifier of the process.cExample:460352888888
-
overdueProcessTemplate: object
overdueProcessTemplate
Overdue Process Template defines the template that was used to create the overdue process's events.
-
startDateTime: string
(date-time)
Create Date/Time defines the creation date/time of the cut process.Example:
2005-04-18T07:50:51-04:00
-
status: string
Allowed Values:
[ "10 ", "20 " ]
Overdue Process Status defines the state of the overdue process. * `10 ` - Active, * `20 ` - InactiveExample:20
-
version: number
Minimum Value:
-99999
Maximum Value:99999
Version
Nested Schema : overdueProcessTemplate
Type:
object
Overdue Process Template defines the template that was used to create the overdue process's events.
Show Source
-
overdueProcessTemplate: string
Maximum Length:
12
Overdue Process Template defines the template that was used to create the overdue process's events.Example:RISKY
Nested Schema : items
Type:
Show Source
object
-
originalAmount: number
Original Amount
-
overdueBillId: object
overdueBillId
-
unpaidAmt: number
Unpaid Amount
-
version: number
Minimum Value:
-99999
Maximum Value:99999
Version
Nested Schema : overdueBillId
Type:
Show Source
object
-
overdueBillIdFkChar: string
(overdueBillIdFkChar)
Nested Schema : items
Type:
Show Source
object
-
dependOnOtherEvents: boolean
If Dependent on Other Events is turned on, the event can only be triggered after the events specified in the Event Dependencies are all Complete or Canceled.Example:
false
-
eventDependencies: object
eventDependencies
-
eventSequence: number
Minimum Value:
-999
Maximum Value:999
Event Sequence is the unique identifier of the event.Example:10
-
overdueEventTypeCode: object
overdueEventTypeCode
-
status: string
Allowed Values:
[ "10 ", "20 ", "30 ", "40 " ]
Event Status: * `10 ` - Pending, * `20 ` - Waiting, * `30 ` - Completed, * `40 ` - Canceled -
triggerDate: string
(date)
If Dependent on Other Events is turned off, enter the desired activation date in the Trigger Date field.Example:
2005-04-19
-
version: number
Minimum Value:
-99999
Maximum Value:99999
Version
Nested Schema : overdueEventTypeCode
Type:
Show Source
object
-
overdueEventTypeCode: string
Maximum Length:
12
Overdue Event Type
Nested Schema : items
Type:
Show Source
object
-
dependentOnSequence: number
Minimum Value:
-999
Maximum Value:999
When Dependent on Other Events is turned on, the Dependent on Sequence field defines the event sequence number on which this event depends.Example:10
-
sequence: number
Minimum Value:
-999
Maximum Value:999
Sequence NumberExample:10
-
version: number
Minimum Value:
-99999
Maximum Value:99999
Version
Root Schema : schema
Type:
Show Source
object
-
account: object
account
-
baseDate: string
(date)
Base Date is reserved for future releases. This field is protected when the overdue process is Inactive.Example:
2004-03-01
-
collectingOn: object
collectingOn
-
events: object
events
-
longComments: string
Maximum Length:
2000
Enter any Comments about the overdue process. This field is protected when the overdue process is Inactive. -
name: string
(name)
-
overdueProcessId: string
Maximum Length:
12
Overdue Process ID is the system-assigned unique identifier of the process.cExample:460352888888
-
overdueProcessTemplate: object
overdueProcessTemplate
Overdue Process Template defines the template that was used to create the overdue process's events.
-
startDateTime: string
(date-time)
Create Date/Time defines the creation date/time of the cut process.Example:
2005-04-18T07:50:51-04:00
-
status: string
Allowed Values:
[ "10 ", "20 " ]
Overdue Process Status defines the state of the overdue process. * `10 ` - Active, * `20 ` - InactiveExample:20
-
version: number
Minimum Value:
-99999
Maximum Value:99999
Version
Nested Schema : overdueProcessTemplate
Type:
object
Overdue Process Template defines the template that was used to create the overdue process's events.
Show Source
-
overdueProcessTemplate: string
Maximum Length:
12
Overdue Process Template defines the template that was used to create the overdue process's events.Example:RISKY
Nested Schema : items
Type:
Show Source
object
-
originalAmount: number
Original Amount
-
overdueBillId: object
overdueBillId
-
unpaidAmt: number
Unpaid Amount
-
version: number
Minimum Value:
-99999
Maximum Value:99999
Version
Nested Schema : overdueBillId
Type:
Show Source
object
-
overdueBillIdFkChar: string
(overdueBillIdFkChar)
Nested Schema : items
Type:
Show Source
object
-
dependOnOtherEvents: boolean
If Dependent on Other Events is turned on, the event can only be triggered after the events specified in the Event Dependencies are all Complete or Canceled.Example:
false
-
eventDependencies: object
eventDependencies
-
eventSequence: number
Minimum Value:
-999
Maximum Value:999
Event Sequence is the unique identifier of the event.Example:10
-
overdueEventTypeCode: object
overdueEventTypeCode
-
status: string
Allowed Values:
[ "10 ", "20 ", "30 ", "40 " ]
Event Status: * `10 ` - Pending, * `20 ` - Waiting, * `30 ` - Completed, * `40 ` - Canceled -
triggerDate: string
(date)
If Dependent on Other Events is turned off, enter the desired activation date in the Trigger Date field.Example:
2005-04-19
-
version: number
Minimum Value:
-99999
Maximum Value:99999
Version
Nested Schema : overdueEventTypeCode
Type:
Show Source
object
-
overdueEventTypeCode: string
Maximum Length:
12
Overdue Event Type
Nested Schema : items
Type:
Show Source
object
-
dependentOnSequence: number
Minimum Value:
-999
Maximum Value:999
When Dependent on Other Events is turned on, the Dependent on Sequence field defines the event sequence number on which this event depends.Example:10
-
sequence: number
Minimum Value:
-999
Maximum Value:999
Sequence NumberExample:10
-
version: number
Minimum Value:
-99999
Maximum Value:99999
Version
Response
Supported Media Types
- application/xml
- application/json
200 Response
Success response
Root Schema : C1OverduePro
Type:
Show Source
object
-
_self: string
_self
-
account: object
account
-
baseDate: string
(date)
Base Date is reserved for future releases. This field is protected when the overdue process is Inactive.Example:
2004-03-01
-
collectingOn: object
collectingOn
-
events: object
events
-
longComments: string
Maximum Length:
2000
Enter any Comments about the overdue process. This field is protected when the overdue process is Inactive. -
name: string
(name)
-
overdueProcessId: string
Maximum Length:
12
Overdue Process ID is the system-assigned unique identifier of the process.cExample:460352888888
-
overdueProcessTemplate: object
overdueProcessTemplate
Overdue Process Template defines the template that was used to create the overdue process's events.
-
startDateTime: string
(date-time)
Create Date/Time defines the creation date/time of the cut process.Example:
2005-04-18T07:50:51-04:00
-
status: string
Allowed Values:
[ "10 ", "20 " ]
Overdue Process Status defines the state of the overdue process. * `10 ` - Active, * `20 ` - InactiveExample:20
-
version: number
Minimum Value:
-99999
Maximum Value:99999
Version
Nested Schema : account
Type:
Show Source
object
-
_link: string
_link
-
accountId: string
Maximum Length:
10
Account ID
Nested Schema : overdueProcessTemplate
Type:
object
Overdue Process Template defines the template that was used to create the overdue process's events.
Show Source
-
_link: string
_link
-
overdueProcessTemplate: string
Maximum Length:
12
Overdue Process Template defines the template that was used to create the overdue process's events.Example:RISKY
Nested Schema : items
Type:
Show Source
object
-
originalAmount: number
Original Amount
-
overdueBillId: object
overdueBillId
-
unpaidAmt: number
Unpaid Amount
-
version: number
Minimum Value:
-99999
Maximum Value:99999
Version
Nested Schema : overdueBillId
Type:
Show Source
object
-
_link: string
_link
-
overdueBillIdFkChar: string
(overdueBillIdFkChar)
Nested Schema : items
Type:
Show Source
object
-
dependOnOtherEvents: boolean
If Dependent on Other Events is turned on, the event can only be triggered after the events specified in the Event Dependencies are all Complete or Canceled.Example:
false
-
eventDependencies: object
eventDependencies
-
eventSequence: number
Minimum Value:
-999
Maximum Value:999
Event Sequence is the unique identifier of the event.Example:10
-
overdueEventTypeCode: object
overdueEventTypeCode
-
status: string
Allowed Values:
[ "10 ", "20 ", "30 ", "40 " ]
Event Status: * `10 ` - Pending, * `20 ` - Waiting, * `30 ` - Completed, * `40 ` - Canceled -
triggerDate: string
(date)
If Dependent on Other Events is turned off, enter the desired activation date in the Trigger Date field.Example:
2005-04-19
-
version: number
Minimum Value:
-99999
Maximum Value:99999
Version
Nested Schema : overdueEventTypeCode
Type:
Show Source
object
-
_link: string
_link
-
overdueEventTypeCode: string
Maximum Length:
12
Overdue Event Type
Nested Schema : items
Type:
Show Source
object
-
dependentOnSequence: number
Minimum Value:
-999
Maximum Value:999
When Dependent on Other Events is turned on, the Dependent on Sequence field defines the event sequence number on which this event depends.Example:10
-
sequence: number
Minimum Value:
-999
Maximum Value:999
Sequence NumberExample:10
-
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.