Get Severance Process
get
/rest/apis/customer/collections/severanceProcesses/{severanceProcessId}
Request
Path Parameters
-
severanceProcessId(required): string
Severance Process ID is the unique system-generated identifier for this severance process.Example:
1033333333
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/xml
- application/json
200 Response
Success response
Root Schema : C1SeveraProc
Type:
Show Source
object
-
_self: string
_self
-
amountStillOwing: number
The Amount Still Owing is the amount of debt older than the Severance Amount Base Date.Example:
0.00
-
collectionAmount: number
Arrears Amount
-
comments: string
Maximum Length:
254
Comments provide additional details about the severance process. -
createdBy: object
createdBy
-
creationDateTime: string
(date-time)
Create Date/Time defines the start date/time of the severance process.Example:
2007-07-02T07:40:37-04:00
-
currency: object
currency
-
daysInArrears: number
Minimum Value:
-999
Maximum Value:999
Defines the age of the arrears in number of days which can be used by the system to calculate the severance amount base date. -
events: object
events
-
eventSequence: number
Minimum Value:
-999
Maximum Value:999
Event Sequence -
premise: object
premise
-
serviceAgreement: object
serviceAgreement
Service Agreement ID is the system-generated identifier of the service agreement to which the severance process is linked.
-
severanceAmountBaseDate: string
(date)
Arrears Date This is the date the event starts aging.
-
severanceProcessId: string
Maximum Length:
10
Severance Process ID is the unique system-generated identifier for this severance process.Example:1033333333
-
severanceProcessTemplate: object
severanceProcessTemplate
Severance Process Template defines the severance events in the process.
-
severanceStatus: string
Allowed Values:
[ "10 ", "20 " ]
Severance Status defines the state of the severance process. * `10 ` - Active, * `20 ` - InactiveExample:20
-
severanceStatusReason: string
Allowed Values:
[ "10 ", "20 ", "30 ", "40 " ]
Reason defines how a severance process became Inactive or why a severance process is Active. * `10 ` - Events Pending, * `20 ` - Completed, * `30 ` - Canceled by System, * `40 ` - Canceled by UserExample:10
-
version: number
Minimum Value:
-99999
Maximum Value:99999
Version
Nested Schema : createdBy
Type:
Show Source
object
-
collectionProcess: object
collectionProcess
Collection Process ID is the unique system-generated identifier for the collection process.
-
eventSequence: number
Minimum Value:
-999
Maximum Value:999
Event Sequence -
severanceCriteriaSequence: string
Maximum Length:
10
Severance Criteria SequenceExample:50
Nested Schema : currency
Type:
Show Source
object
-
_link: string
_link
-
currency: string
Maximum Length:
3
Currency Code
Nested Schema : premise
Type:
Show Source
object
-
_link: string
_link
-
premiseId: string
Maximum Length:
10
The Premise ID is a system assigned random number that stays with a premise for life.
Nested Schema : serviceAgreement
Type:
object
Service Agreement ID is the system-generated identifier of the service agreement to which the severance process is linked.
Show Source
-
_link: string
_link
-
serviceAgreement: string
Maximum Length:
10
Service Agreement
Nested Schema : severanceProcessTemplate
Type:
object
Severance Process Template defines the severance events in the process.
Show Source
-
_link: string
_link
-
severanceProcessTemplate: string
Maximum Length:
12
Severance Process Template defines the severance events in the process.Example:NORMAL UTIL
Nested Schema : collectionProcess
Type:
object
Collection Process ID is the unique system-generated identifier for the collection process.
Show Source
-
_link: string
_link
-
collectionProcess: string
Maximum Length:
10
Collection Process ID
Nested Schema : items
Type:
Show Source
object
-
completionDate: string
(date)
If the status of the event is complete, the Completion Date is displayed with the date on which the system completes the event.
-
daysAfterPreviousResponse: number
Minimum Value:
-999
Maximum Value:999
Days After Prev Response defines how a dependent event's trigger date is calculated. The trigger date is set equal to X days after the last dependent event is completed, where X is the number in this field.Example:0
-
dependOnOtherEvents: boolean
If Dependent on Other Events is defined as true, then the event's trigger date is only determined after the events on which it depends are completed.Example:
false
-
eventCustomerContacts: object
eventCustomerContacts
-
eventDependencies: object
eventDependencies
-
eventFieldActivities: object
eventFieldActivities
-
eventSequence: number
Minimum Value:
-999
Maximum Value:999
Event Sequence -
severanceEvent: string
Maximum Length:
150
The Severance Events contains the severance events that comprise the severance process.Example:The Severance Events contains the severance events that comprise the severance process.
-
severanceEventStatus: string
Allowed Values:
[ "10 ", "20 ", "30 ", "40 " ]
Severance Event Status defines the state of the event. * `10 ` - Pending, * `20 ` - Awaiting Field Activity, * `30 ` - Completed, * `40 ` - CanceledExample:20
-
severanceEventType: object
severanceEventType
-
triggerDate: string
(date)
The Trigger Date defines the date when the system completes the event.Example:
2007-07-02
-
version: number
Minimum Value:
-99999
Maximum Value:99999
Version
Nested Schema : severanceEventType
Type:
Show Source
object
-
_link: string
_link
-
severanceEventType: string
Maximum Length:
12
Severance Event Type
Nested Schema : items
Type:
Show Source
object
-
ccInfo: string
Maximum Length:
200
CC Info contains information about the customer contacts that were created when the event was activated. This information will only be populated when the event's event type causes a customer contact to be created (note, letters are generated via the creation of a customer contact). -
customerContact: object
customerContact
-
sequence: 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
-
dependentOnSequence: number
Minimum Value:
-999
Maximum Value:999
When Dependent on Other Events is turned on, a grid appears at the bottom of the page which displays the Dependent on Sequence field where you define the event sequence number on which this event depends.Example:20
-
eventSequence: number
Minimum Value:
-999
Maximum Value:999
Event Sequence -
sequence: number
Minimum Value:
-999
Maximum Value:999
Sequence Number -
version: number
Minimum Value:
-99999
Maximum Value:99999
Version
Nested Schema : items
Type:
Show Source
object
-
fieldActivity: object
fieldActivity
-
sequence: number
Minimum Value:
-999
Maximum Value:999
Event Sequence -
servicePoint: object
servicePoint
-
version: number
Minimum Value:
-99999
Maximum Value:99999
Version
Nested Schema : fieldActivity
Type:
Show Source
object
-
_link: string
_link
-
fieldActivityId: string
Maximum Length:
10
Field Activity ID -
fieldActivityInformation: string
Maximum Length:
254
Field Activity Information
Nested Schema : servicePoint
Type:
Show Source
object
-
_link: string
_link
-
servicePointId: string
Maximum Length:
10
Service Point ID -
spInformation: string
Maximum Length:
254
SP Info
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.