Create collection Process
post
https://server:port/spl/rest/apis/customer/collections/collectionProcesss/
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
-
calculationDateUsingDaysInArrears: number
Minimum Value:
-999
Maximum Value:999
You can have the system calculate Severance Amount Base Date for you by entering the age of the arrears in the field embedded in Calculate Date Using Days In Arrears. -
collectionAmountBaseDate: string
(date)
Arrears Date is the date the event starts aging.
-
collectionClassControl: object
collectionClassControl
Collection Class Control defines the debt class (i.e., the type of debt) associated with the collection process.
-
collectionConditionPriority: string
Allowed Values:
[ "10 ", "20 ", "30 ", "40 ", "50 ", "60 ", "70 ", "80 ", "90 " ]
Collection Condition Priority * `10 ` - Priority 10 - Highest, * `20 ` - Priority 20, * `30 ` - Priority 30, * `40 ` - Priority 40, * `50 ` - Priority 50, * `60 ` - Priority 60, * `70 ` - Priority 70, * `80 ` - Priority 80, * `90 ` - Priority 90 - LowestExample:10
-
collectionProcessId: string
Maximum Length:
10
Collection Process ID is the unique system-generated identifier for this collection process.Example:6799999999
-
collectionProcessTemplate: object
collectionProcessTemplate
Collection Process Template defines the collection events in the process.
-
collectionStatus: string
Allowed Values:
[ "10 ", "20 " ]
Collection Status defines the state of the collection process. * `10 ` - Active, * `20 ` - InactiveExample:10
-
comments: string
Maximum Length:
254
Enter any Comments about the collection process. -
creationDateTime: string
(date-time)
Creation Date/Time defines the start date/time of the collection process.Example:
2021-12-02T03:07:47-05:00
-
currency: object
currency
-
events: object
events
-
priority: string
Allowed Values:
[ "10 ", "20 ", "30 ", "40 ", "50 ", "60 ", "70 ", "80 ", "85 ", "90 " ]
priority * `10 ` - Priority 10 -- Highest, * `20 ` - Priority 20, * `30 ` - Priority 30, * `40 ` - Priority 40, * `50 ` - Priority 50, * `60 ` - Priority 60, * `70 ` - Priority 70, * `80 ` - Priority 80, * `85 ` - Priority 85, * `90 ` - Priority 90 -- LowestExample:10
-
reason: string
Allowed Values:
[ "10 ", "20 ", "30 ", "40 " ]
Collection Status Reason defines how a collection process became Inactive or why a collection process is Active. * `10 ` - Events Pending, * `20 ` - Completed, * `30 ` - Canceled by System, * `40 ` - Canceled by UserExample:20
-
SAs: object
SAs
-
version: number
Minimum Value:
-99999
Maximum Value:99999
Version
Nested Schema : collectionClassControl
Type:
object
Collection Class Control defines the debt class (i.e., the type of debt) associated with the collection process.
Show Source
-
collectionClassControl: string
Maximum Length:
20
Collection Class Control defines the debt class (i.e., the type of debt) associated with the collection process.Example:RES - REGULATED
Nested Schema : collectionProcessTemplate
Type:
object
Collection Process Template defines the collection events in the process.
Show Source
-
collectionProcessTemplate: string
Maximum Length:
12
Collection Process Template defines the collection events in the process.Example:NORMAL REGUL
Nested Schema : items
Type:
Show Source
object
-
collectionEventStatus: string
Allowed Values:
[ "10 ", "30 ", "40 " ]
Collection Event Status defines the state of the event. * `10 ` - Pending, * `30 ` - Completed, * `40 ` - CanceledExample:40
-
collectionEventType: object
collectionEventType
-
completionDate: string
(date)
If the status of the event is complete, the Completion Date is displayed with the date on which the system completed the event.Example:
2021-12-02
-
eventCustomerContact: object
eventCustomerContact
-
eventSequence: number
Minimum Value:
-999
Maximum Value:999
Event Sequence -
triggerDate: string
(date)
The Trigger Date defines the date when the system completes (i.e., executes) the event.Example:
2022-01-01
-
version: number
Minimum Value:
-99999
Maximum Value:99999
Version
Nested Schema : collectionEventType
Type:
Show Source
object
-
collectionEventType: string
Maximum Length:
12
Collection Event Type
Nested Schema : items
Type:
Show Source
object
-
customerContact: object
customerContact
-
customerContactInformation: string
Maximum Length:
200
Customer Contact Information -
eventSequence: number
Minimum Value:
-999
Maximum Value:999
Event Sequence -
version: number
Minimum Value:
-99999
Maximum Value:99999
Version
Nested Schema : customerContact
Type:
Show Source
object
-
customerContactId: string
Maximum Length:
10
Customer Contact ID
Nested Schema : items
Type:
Show Source
object
-
collectionAmount: number
Minimum Value:
-999999.9999
Maximum Value:999999.9999
Customer Contact Information -
serviceAgreement: object
serviceAgreement
-
status: string
Allowed Values:
[ "10 ", "20 " ]
Status: * `10 ` - Active, * `20 ` - Inactive -
version: number
Minimum Value:
-99999
Maximum Value:99999
Version
Nested Schema : serviceAgreement
Type:
Show Source
object
-
serviceAgreementId: string
Maximum Length:
10
Service Agreement
Root Schema : schema
Type:
Show Source
object
-
account: object
account
-
calculationDateUsingDaysInArrears: number
Minimum Value:
-999
Maximum Value:999
You can have the system calculate Severance Amount Base Date for you by entering the age of the arrears in the field embedded in Calculate Date Using Days In Arrears. -
collectionAmountBaseDate: string
(date)
Arrears Date is the date the event starts aging.
-
collectionClassControl: object
collectionClassControl
Collection Class Control defines the debt class (i.e., the type of debt) associated with the collection process.
-
collectionConditionPriority: string
Allowed Values:
[ "10 ", "20 ", "30 ", "40 ", "50 ", "60 ", "70 ", "80 ", "90 " ]
Collection Condition Priority * `10 ` - Priority 10 - Highest, * `20 ` - Priority 20, * `30 ` - Priority 30, * `40 ` - Priority 40, * `50 ` - Priority 50, * `60 ` - Priority 60, * `70 ` - Priority 70, * `80 ` - Priority 80, * `90 ` - Priority 90 - LowestExample:10
-
collectionProcessId: string
Maximum Length:
10
Collection Process ID is the unique system-generated identifier for this collection process.Example:6799999999
-
collectionProcessTemplate: object
collectionProcessTemplate
Collection Process Template defines the collection events in the process.
-
collectionStatus: string
Allowed Values:
[ "10 ", "20 " ]
Collection Status defines the state of the collection process. * `10 ` - Active, * `20 ` - InactiveExample:10
-
comments: string
Maximum Length:
254
Enter any Comments about the collection process. -
creationDateTime: string
(date-time)
Creation Date/Time defines the start date/time of the collection process.Example:
2021-12-02T03:07:47-05:00
-
currency: object
currency
-
events: object
events
-
priority: string
Allowed Values:
[ "10 ", "20 ", "30 ", "40 ", "50 ", "60 ", "70 ", "80 ", "85 ", "90 " ]
priority * `10 ` - Priority 10 -- Highest, * `20 ` - Priority 20, * `30 ` - Priority 30, * `40 ` - Priority 40, * `50 ` - Priority 50, * `60 ` - Priority 60, * `70 ` - Priority 70, * `80 ` - Priority 80, * `85 ` - Priority 85, * `90 ` - Priority 90 -- LowestExample:10
-
reason: string
Allowed Values:
[ "10 ", "20 ", "30 ", "40 " ]
Collection Status Reason defines how a collection process became Inactive or why a collection process is Active. * `10 ` - Events Pending, * `20 ` - Completed, * `30 ` - Canceled by System, * `40 ` - Canceled by UserExample:20
-
SAs: object
SAs
-
version: number
Minimum Value:
-99999
Maximum Value:99999
Version
Nested Schema : collectionClassControl
Type:
object
Collection Class Control defines the debt class (i.e., the type of debt) associated with the collection process.
Show Source
-
collectionClassControl: string
Maximum Length:
20
Collection Class Control defines the debt class (i.e., the type of debt) associated with the collection process.Example:RES - REGULATED
Nested Schema : collectionProcessTemplate
Type:
object
Collection Process Template defines the collection events in the process.
Show Source
-
collectionProcessTemplate: string
Maximum Length:
12
Collection Process Template defines the collection events in the process.Example:NORMAL REGUL
Nested Schema : items
Type:
Show Source
object
-
collectionEventStatus: string
Allowed Values:
[ "10 ", "30 ", "40 " ]
Collection Event Status defines the state of the event. * `10 ` - Pending, * `30 ` - Completed, * `40 ` - CanceledExample:40
-
collectionEventType: object
collectionEventType
-
completionDate: string
(date)
If the status of the event is complete, the Completion Date is displayed with the date on which the system completed the event.Example:
2021-12-02
-
eventCustomerContact: object
eventCustomerContact
-
eventSequence: number
Minimum Value:
-999
Maximum Value:999
Event Sequence -
triggerDate: string
(date)
The Trigger Date defines the date when the system completes (i.e., executes) the event.Example:
2022-01-01
-
version: number
Minimum Value:
-99999
Maximum Value:99999
Version
Nested Schema : collectionEventType
Type:
Show Source
object
-
collectionEventType: string
Maximum Length:
12
Collection Event Type
Nested Schema : items
Type:
Show Source
object
-
customerContact: object
customerContact
-
customerContactInformation: string
Maximum Length:
200
Customer Contact Information -
eventSequence: number
Minimum Value:
-999
Maximum Value:999
Event Sequence -
version: number
Minimum Value:
-99999
Maximum Value:99999
Version
Nested Schema : customerContact
Type:
Show Source
object
-
customerContactId: string
Maximum Length:
10
Customer Contact ID
Nested Schema : items
Type:
Show Source
object
-
collectionAmount: number
Minimum Value:
-999999.9999
Maximum Value:999999.9999
Customer Contact Information -
serviceAgreement: object
serviceAgreement
-
status: string
Allowed Values:
[ "10 ", "20 " ]
Status: * `10 ` - Active, * `20 ` - Inactive -
version: number
Minimum Value:
-99999
Maximum Value:99999
Version
Nested Schema : serviceAgreement
Type:
Show Source
object
-
serviceAgreementId: string
Maximum Length:
10
Service Agreement
Response
Supported Media Types
- application/xml
- application/json
200 Response
Success response
Root Schema : C1CollProces
Type:
Show Source
object
-
_self: string
_self
-
account: object
account
-
calculationDateUsingDaysInArrears: number
Minimum Value:
-999
Maximum Value:999
You can have the system calculate Severance Amount Base Date for you by entering the age of the arrears in the field embedded in Calculate Date Using Days In Arrears. -
collectionAmountBaseDate: string
(date)
Arrears Date is the date the event starts aging.
-
collectionClassControl: object
collectionClassControl
Collection Class Control defines the debt class (i.e., the type of debt) associated with the collection process.
-
collectionConditionPriority: string
Allowed Values:
[ "10 ", "20 ", "30 ", "40 ", "50 ", "60 ", "70 ", "80 ", "90 " ]
Collection Condition Priority * `10 ` - Priority 10 - Highest, * `20 ` - Priority 20, * `30 ` - Priority 30, * `40 ` - Priority 40, * `50 ` - Priority 50, * `60 ` - Priority 60, * `70 ` - Priority 70, * `80 ` - Priority 80, * `90 ` - Priority 90 - LowestExample:10
-
collectionProcessId: string
Maximum Length:
10
Collection Process ID is the unique system-generated identifier for this collection process.Example:6799999999
-
collectionProcessTemplate: object
collectionProcessTemplate
Collection Process Template defines the collection events in the process.
-
collectionStatus: string
Allowed Values:
[ "10 ", "20 " ]
Collection Status defines the state of the collection process. * `10 ` - Active, * `20 ` - InactiveExample:10
-
comments: string
Maximum Length:
254
Enter any Comments about the collection process. -
creationDateTime: string
(date-time)
Creation Date/Time defines the start date/time of the collection process.Example:
2021-12-02T03:07:47-05:00
-
currency: object
currency
-
events: object
events
-
priority: string
Allowed Values:
[ "10 ", "20 ", "30 ", "40 ", "50 ", "60 ", "70 ", "80 ", "85 ", "90 " ]
priority * `10 ` - Priority 10 -- Highest, * `20 ` - Priority 20, * `30 ` - Priority 30, * `40 ` - Priority 40, * `50 ` - Priority 50, * `60 ` - Priority 60, * `70 ` - Priority 70, * `80 ` - Priority 80, * `85 ` - Priority 85, * `90 ` - Priority 90 -- LowestExample:10
-
reason: string
Allowed Values:
[ "10 ", "20 ", "30 ", "40 " ]
Collection Status Reason defines how a collection process became Inactive or why a collection process is Active. * `10 ` - Events Pending, * `20 ` - Completed, * `30 ` - Canceled by System, * `40 ` - Canceled by UserExample:20
-
SAs: object
SAs
-
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 : collectionClassControl
Type:
object
Collection Class Control defines the debt class (i.e., the type of debt) associated with the collection process.
Show Source
-
_link: string
_link
-
collectionClassControl: string
Maximum Length:
20
Collection Class Control defines the debt class (i.e., the type of debt) associated with the collection process.Example:RES - REGULATED
Nested Schema : collectionProcessTemplate
Type:
object
Collection Process Template defines the collection events in the process.
Show Source
-
_link: string
_link
-
collectionProcessTemplate: string
Maximum Length:
12
Collection Process Template defines the collection events in the process.Example:NORMAL REGUL
Nested Schema : currency
Type:
Show Source
object
-
_link: string
_link
-
currency: string
Maximum Length:
3
Currency Code
Nested Schema : items
Type:
Show Source
object
-
collectionEventStatus: string
Allowed Values:
[ "10 ", "30 ", "40 " ]
Collection Event Status defines the state of the event. * `10 ` - Pending, * `30 ` - Completed, * `40 ` - CanceledExample:40
-
collectionEventType: object
collectionEventType
-
completionDate: string
(date)
If the status of the event is complete, the Completion Date is displayed with the date on which the system completed the event.Example:
2021-12-02
-
eventCustomerContact: object
eventCustomerContact
-
eventSequence: number
Minimum Value:
-999
Maximum Value:999
Event Sequence -
triggerDate: string
(date)
The Trigger Date defines the date when the system completes (i.e., executes) the event.Example:
2022-01-01
-
version: number
Minimum Value:
-99999
Maximum Value:99999
Version
Nested Schema : collectionEventType
Type:
Show Source
object
-
_link: string
_link
-
collectionEventType: string
Maximum Length:
12
Collection Event Type
Nested Schema : items
Type:
Show Source
object
-
customerContact: object
customerContact
-
customerContactInformation: string
Maximum Length:
200
Customer Contact Information -
eventSequence: number
Minimum Value:
-999
Maximum Value:999
Event Sequence -
version: number
Minimum Value:
-99999
Maximum Value:99999
Version
Nested Schema : customerContact
Type:
Show Source
object
-
_link: string
_link
-
customerContactId: string
Maximum Length:
10
Customer Contact ID
Nested Schema : items
Type:
Show Source
object
-
collectionAmount: number
Minimum Value:
-999999.9999
Maximum Value:999999.9999
Customer Contact Information -
serviceAgreement: object
serviceAgreement
-
status: string
Allowed Values:
[ "10 ", "20 " ]
Status: * `10 ` - Active, * `20 ` - Inactive -
version: number
Minimum Value:
-99999
Maximum Value:99999
Version
Nested Schema : serviceAgreement
Type:
Show Source
object
-
_link: string
_link
-
serviceAgreementId: string
Maximum Length:
10
Service Agreement
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.