Get Write Off Process
get
https://server:port/spl/rest/apis/customer/collections/writeoffProcesses/{writeOffProcessId}
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 : C1WriteOffPr
Type:
Show Source
object
-
_self: string
_self
-
account: object
account
-
comments: string
Maximum Length:
254
Enter any Comments about the write-off process.Example:TESTQA
-
creationDateTime: string
(date-time)
Create Date/Time defines the start date/time of the write-off process.Example:
2005-04-18T07:50:51-04:00
-
currency: object
currency
-
events: object
events
-
SAs: object
SAs
-
version: number
Minimum Value:
-99999
Maximum Value:99999
Version -
writeOffControl: object
writeOffControl
Write Off Control defines the write-off debt class (i.e., the type of debt) associated with the write-off process.
-
writeOffProcessId: string
Maximum Length:
10
Write Off Process ID is the unique system-generated identifier for this write-off process. -
writeOffProcessTemplate: object
writeOffProcessTemplate
Write Off Process Template defines the write-off events in the process.
-
writeOffStatus: string
Allowed Values:
[ "10 ", "20 " ]
Write-off Status defines the state of the write-off process. * `10 ` - Active, * `20 ` - InactiveExample:20
-
writeOffStatusReason: string
Allowed Values:
[ "10 ", "20 ", "30 ", "40 " ]
Reason defines how a write-off process became Inactive or why a write-off process is Active. * `10 ` - Events Pending, * `20 ` - Completed, * `30 ` - Canceled by System, * `40 ` - Canceled by UserExample:20
Nested Schema : account
Type:
Show Source
object
-
_link: string
_link
-
accountId: string
Maximum Length:
10
Account ID
Nested Schema : currency
Type:
Show Source
object
-
_link: string
_link
-
currency: string
Maximum Length:
3
Currency Code
Nested Schema : writeOffControl
Type:
object
Write Off Control defines the write-off debt class (i.e., the type of debt) associated with the write-off process.
Show Source
-
_link: string
_link
-
writeOffControl: string
Maximum Length:
20
Write Off Control defines the write-off debt class (i.e., the type of debt) associated with the write-off process.Example:RES-REGU
Nested Schema : writeOffProcessTemplate
Type:
object
Write Off Process Template defines the write-off events in the process.
Show Source
-
_link: string
_link
-
writeOffProcessTemplate: string
Maximum Length:
12
Write Off Process Template
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 completed the event.Example:
2009-12-13
-
eventCustomerContact: object
eventCustomerContact
-
eventSequence: number
Minimum Value:
-999
Maximum Value:999
Event Sequence is the unique identifier of the event.Example:10
-
triggerDate: string
(date)
The Trigger Date defines the date when the system completes (i.e., executes) the event.Example:
2009-03-13
-
version: number
Minimum Value:
-99999
Maximum Value:99999
Version -
writeOffEventStatus: string
Allowed Values:
[ "10 ", "30 ", "40 " ]
Write Off Event Status defines the state of the event. * `10 ` - Pending, * `30 ` - Completed, * `40 ` - CanceledExample:10
-
writeOffEventType: object
writeOffEventType
Nested Schema : writeOffEventType
Type:
Show Source
object
-
_link: string
_link
-
writeOffEventType: string
Maximum Length:
12
Write Off Event Type
Nested Schema : items
Type:
Show Source
object
-
customerContact: object
customerContact
-
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
-
serviceAgreement: object
serviceAgreement
-
version: number
Minimum Value:
-99999
Maximum Value:99999
Version -
writeOffSAStatus: string
Allowed Values:
[ "10 ", "20 " ]
Write Off SA Status defines the state of the service agreement in respect of the write-off process. * `10 ` - Active, * `20 ` - InactiveExample:10
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.