Jump to

• Request
• Response

Update Write Off Process

put

https://server:port/spl/rest/apis/customer/collections/writeoffProcesses/{writeOffProcessId}

Request

Path Parameters

• writeOffProcessId(required): string

Supported Media Types

• application/xml
• application/json

Request Body - application/xml ()

Root Schema : schema

Type: object

Show Source

• 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
• 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 ` - Inactive

  Example: 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 User

  Example: 20

{
    "type":"object",
    "properties":{
        "writeOffProcessId":{
            "type":"string",
            "maxLength":10,
            "description":"Write Off Process ID is the unique system-generated identifier for this write-off process."
        },
        "account":{
            "type":"object",
            "properties":{
                "accountId":{
                    "type":"string",
                    "maxLength":10,
                    "description":"Account ID"
                }
            }
        },
        "writeOffProcessTemplate":{
            "type":"object",
            "description":"Write Off Process Template defines the write-off events in the process.",
            "properties":{
                "writeOffProcessTemplate":{
                    "type":"string",
                    "maxLength":12,
                    "description":"Write Off Process Template"
                }
            }
        },
        "writeOffStatus":{
            "type":"string",
            "enum":[
                "10  ",
                "20  "
            ],
            "description":"Write-off Status defines the state of the write-off process.\n* `10  ` - Active,\n* `20  ` - Inactive",
            "example":"20"
        },
        "writeOffControl":{
            "type":"object",
            "description":"Write Off Control defines the write-off debt class (i.e., the type of debt) associated with the write-off process.",
            "properties":{
                "writeOffControl":{
                    "type":"string",
                    "maxLength":20,
                    "description":"Write Off Control defines the write-off debt class (i.e., the type of debt) associated with the write-off process.",
                    "example":"RES-REGU"
                }
            }
        },
        "writeOffStatusReason":{
            "type":"string",
            "enum":[
                "10  ",
                "20  ",
                "30  ",
                "40  "
            ],
            "description":"Reason defines how a write-off process became Inactive or why a write-off process is Active.\n* `10  ` - Events Pending,\n* `20  ` - Completed,\n* `30  ` - Canceled by System,\n* `40  ` - Canceled by User",
            "example":"20"
        },
        "creationDateTime":{
            "type":"string",
            "format":"date-time",
            "description":"Create Date/Time defines the start date/time of the write-off process.",
            "example":"2005-04-18T07:50:51-04:00"
        },
        "comments":{
            "type":"string",
            "maxLength":254,
            "description":"Enter any Comments about the write-off process.",
            "example":"TESTQA"
        },
        "version":{
            "type":"number",
            "maximum":99999,
            "minimum":-99999,
            "description":"Version"
        },
        "SAs":{
            "type":"object",
            "properties":{
                "_data":{
                    "type":"array",
                    "items":{
                        "type":"object",
                        "properties":{
                            "serviceAgreement":{
                                "type":"object",
                                "properties":{
                                    "serviceAgreementId":{
                                        "type":"string",
                                        "maxLength":10,
                                        "description":"Service Agreement"
                                    }
                                }
                            },
                            "writeOffSAStatus":{
                                "type":"string",
                                "enum":[
                                    "10  ",
                                    "20  "
                                ],
                                "description":"Write Off SA Status defines the state of the service agreement in respect of the write-off process.\n* `10  ` - Active,\n* `20  ` - Inactive",
                                "example":"10"
                            },
                            "version":{
                                "type":"number",
                                "maximum":99999,
                                "minimum":-99999,
                                "description":"Version"
                            }
                        }
                    }
                }
            }
        },
        "events":{
            "type":"object",
            "properties":{
                "_data":{
                    "type":"array",
                    "items":{
                        "type":"object",
                        "properties":{
                            "eventSequence":{
                                "type":"number",
                                "maximum":999,
                                "minimum":-999,
                                "description":"Event Sequence is the unique identifier of the event.",
                                "example":"10"
                            },
                            "writeOffEventStatus":{
                                "type":"string",
                                "enum":[
                                    "10  ",
                                    "30  ",
                                    "40  "
                                ],
                                "description":"Write Off Event Status defines the state of the event.\n* `10  ` - Pending,\n* `30  ` - Completed,\n* `40  ` - Canceled",
                                "example":"10"
                            },
                            "writeOffEventType":{
                                "type":"object",
                                "properties":{
                                    "writeOffEventType":{
                                        "type":"string",
                                        "maxLength":12,
                                        "description":"Write Off Event Type"
                                    }
                                }
                            },
                            "triggerDate":{
                                "type":"string",
                                "format":"date",
                                "description":"The Trigger Date defines the date when the system completes (i.e., executes) the event.",
                                "example":"2009-03-13"
                            },
                            "completionDate":{
                                "type":"string",
                                "format":"date",
                                "description":"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"
                            },
                            "version":{
                                "type":"number",
                                "maximum":99999,
                                "minimum":-99999,
                                "description":"Version"
                            },
                            "eventCustomerContact":{
                                "type":"object",
                                "properties":{
                                    "_data":{
                                        "type":"array",
                                        "items":{
                                            "type":"object",
                                            "properties":{
                                                "customerContact":{
                                                    "type":"object",
                                                    "properties":{
                                                        "customerContactId":{
                                                            "type":"string",
                                                            "maxLength":10,
                                                            "description":"Customer Contact ID"
                                                        }
                                                    }
                                                },
                                                "version":{
                                                    "type":"number",
                                                    "maximum":99999,
                                                    "minimum":-99999,
                                                    "description":"Version"
                                                }
                                            }
                                        }
                                    }
                                }
                            }
                        }
                    }
                }
            }
        }
    },
    "xml":{
        "name":"C1WriteOffPr"
    }
}

Nested Schema : account

Type: object

Show Source

• accountId: string
  Maximum Length: 10

  Account ID

{
    "type":"object",
    "properties":{
        "accountId":{
            "type":"string",
            "maxLength":10,
            "description":"Account ID"
        }
    }
}

Nested Schema : events

Type: object

Show Source

• _data: array _data

{
    "type":"object",
    "properties":{
        "_data":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "eventSequence":{
                        "type":"number",
                        "maximum":999,
                        "minimum":-999,
                        "description":"Event Sequence is the unique identifier of the event.",
                        "example":"10"
                    },
                    "writeOffEventStatus":{
                        "type":"string",
                        "enum":[
                            "10  ",
                            "30  ",
                            "40  "
                        ],
                        "description":"Write Off Event Status defines the state of the event.\n* `10  ` - Pending,\n* `30  ` - Completed,\n* `40  ` - Canceled",
                        "example":"10"
                    },
                    "writeOffEventType":{
                        "type":"object",
                        "properties":{
                            "writeOffEventType":{
                                "type":"string",
                                "maxLength":12,
                                "description":"Write Off Event Type"
                            }
                        }
                    },
                    "triggerDate":{
                        "type":"string",
                        "format":"date",
                        "description":"The Trigger Date defines the date when the system completes (i.e., executes) the event.",
                        "example":"2009-03-13"
                    },
                    "completionDate":{
                        "type":"string",
                        "format":"date",
                        "description":"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"
                    },
                    "version":{
                        "type":"number",
                        "maximum":99999,
                        "minimum":-99999,
                        "description":"Version"
                    },
                    "eventCustomerContact":{
                        "type":"object",
                        "properties":{
                            "_data":{
                                "type":"array",
                                "items":{
                                    "type":"object",
                                    "properties":{
                                        "customerContact":{
                                            "type":"object",
                                            "properties":{
                                                "customerContactId":{
                                                    "type":"string",
                                                    "maxLength":10,
                                                    "description":"Customer Contact ID"
                                                }
                                            }
                                        },
                                        "version":{
                                            "type":"number",
                                            "maximum":99999,
                                            "minimum":-99999,
                                            "description":"Version"
                                        }
                                    }
                                }
                            }
                        }
                    }
                }
            }
        }
    }
}

Nested Schema : SAs

Type: object

Show Source

• _data: array _data

{
    "type":"object",
    "properties":{
        "_data":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "serviceAgreement":{
                        "type":"object",
                        "properties":{
                            "serviceAgreementId":{
                                "type":"string",
                                "maxLength":10,
                                "description":"Service Agreement"
                            }
                        }
                    },
                    "writeOffSAStatus":{
                        "type":"string",
                        "enum":[
                            "10  ",
                            "20  "
                        ],
                        "description":"Write Off SA Status defines the state of the service agreement in respect of the write-off process.\n* `10  ` - Active,\n* `20  ` - Inactive",
                        "example":"10"
                    },
                    "version":{
                        "type":"number",
                        "maximum":99999,
                        "minimum":-99999,
                        "description":"Version"
                    }
                }
            }
        }
    }
}

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

• 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

{
    "type":"object",
    "description":"Write Off Control defines the write-off debt class (i.e., the type of debt) associated with the write-off process.",
    "properties":{
        "writeOffControl":{
            "type":"string",
            "maxLength":20,
            "description":"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

• writeOffProcessTemplate: string
  Maximum Length: 12

  Write Off Process Template

{
    "type":"object",
    "description":"Write Off Process Template defines the write-off events in the process.",
    "properties":{
        "writeOffProcessTemplate":{
            "type":"string",
            "maxLength":12,
            "description":"Write Off Process Template"
        }
    }
}

Nested Schema : _data

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "eventSequence":{
                "type":"number",
                "maximum":999,
                "minimum":-999,
                "description":"Event Sequence is the unique identifier of the event.",
                "example":"10"
            },
            "writeOffEventStatus":{
                "type":"string",
                "enum":[
                    "10  ",
                    "30  ",
                    "40  "
                ],
                "description":"Write Off Event Status defines the state of the event.\n* `10  ` - Pending,\n* `30  ` - Completed,\n* `40  ` - Canceled",
                "example":"10"
            },
            "writeOffEventType":{
                "type":"object",
                "properties":{
                    "writeOffEventType":{
                        "type":"string",
                        "maxLength":12,
                        "description":"Write Off Event Type"
                    }
                }
            },
            "triggerDate":{
                "type":"string",
                "format":"date",
                "description":"The Trigger Date defines the date when the system completes (i.e., executes) the event.",
                "example":"2009-03-13"
            },
            "completionDate":{
                "type":"string",
                "format":"date",
                "description":"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"
            },
            "version":{
                "type":"number",
                "maximum":99999,
                "minimum":-99999,
                "description":"Version"
            },
            "eventCustomerContact":{
                "type":"object",
                "properties":{
                    "_data":{
                        "type":"array",
                        "items":{
                            "type":"object",
                            "properties":{
                                "customerContact":{
                                    "type":"object",
                                    "properties":{
                                        "customerContactId":{
                                            "type":"string",
                                            "maxLength":10,
                                            "description":"Customer Contact ID"
                                        }
                                    }
                                },
                                "version":{
                                    "type":"number",
                                    "maximum":99999,
                                    "minimum":-99999,
                                    "description":"Version"
                                }
                            }
                        }
                    }
                }
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• 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 ` - Canceled

  Example: 10
• writeOffEventType: object writeOffEventType

{
    "type":"object",
    "properties":{
        "eventSequence":{
            "type":"number",
            "maximum":999,
            "minimum":-999,
            "description":"Event Sequence is the unique identifier of the event.",
            "example":"10"
        },
        "writeOffEventStatus":{
            "type":"string",
            "enum":[
                "10  ",
                "30  ",
                "40  "
            ],
            "description":"Write Off Event Status defines the state of the event.\n* `10  ` - Pending,\n* `30  ` - Completed,\n* `40  ` - Canceled",
            "example":"10"
        },
        "writeOffEventType":{
            "type":"object",
            "properties":{
                "writeOffEventType":{
                    "type":"string",
                    "maxLength":12,
                    "description":"Write Off Event Type"
                }
            }
        },
        "triggerDate":{
            "type":"string",
            "format":"date",
            "description":"The Trigger Date defines the date when the system completes (i.e., executes) the event.",
            "example":"2009-03-13"
        },
        "completionDate":{
            "type":"string",
            "format":"date",
            "description":"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"
        },
        "version":{
            "type":"number",
            "maximum":99999,
            "minimum":-99999,
            "description":"Version"
        },
        "eventCustomerContact":{
            "type":"object",
            "properties":{
                "_data":{
                    "type":"array",
                    "items":{
                        "type":"object",
                        "properties":{
                            "customerContact":{
                                "type":"object",
                                "properties":{
                                    "customerContactId":{
                                        "type":"string",
                                        "maxLength":10,
                                        "description":"Customer Contact ID"
                                    }
                                }
                            },
                            "version":{
                                "type":"number",
                                "maximum":99999,
                                "minimum":-99999,
                                "description":"Version"
                            }
                        }
                    }
                }
            }
        }
    }
}

Nested Schema : eventCustomerContact

Type: object

Show Source

• _data: array _data

{
    "type":"object",
    "properties":{
        "_data":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "customerContact":{
                        "type":"object",
                        "properties":{
                            "customerContactId":{
                                "type":"string",
                                "maxLength":10,
                                "description":"Customer Contact ID"
                            }
                        }
                    },
                    "version":{
                        "type":"number",
                        "maximum":99999,
                        "minimum":-99999,
                        "description":"Version"
                    }
                }
            }
        }
    }
}

Nested Schema : writeOffEventType

Type: object

Show Source

• writeOffEventType: string
  Maximum Length: 12

  Write Off Event Type

{
    "type":"object",
    "properties":{
        "writeOffEventType":{
            "type":"string",
            "maxLength":12,
            "description":"Write Off Event Type"
        }
    }
}

Nested Schema : _data

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "customerContact":{
                "type":"object",
                "properties":{
                    "customerContactId":{
                        "type":"string",
                        "maxLength":10,
                        "description":"Customer Contact ID"
                    }
                }
            },
            "version":{
                "type":"number",
                "maximum":99999,
                "minimum":-99999,
                "description":"Version"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• customerContact: object customerContact
• version: number
  Minimum Value: -99999

  Maximum Value: 99999

  Version

{
    "type":"object",
    "properties":{
        "customerContact":{
            "type":"object",
            "properties":{
                "customerContactId":{
                    "type":"string",
                    "maxLength":10,
                    "description":"Customer Contact ID"
                }
            }
        },
        "version":{
            "type":"number",
            "maximum":99999,
            "minimum":-99999,
            "description":"Version"
        }
    }
}

Nested Schema : customerContact

Type: object

Show Source

• customerContactId: string
  Maximum Length: 10

  Customer Contact ID

{
    "type":"object",
    "properties":{
        "customerContactId":{
            "type":"string",
            "maxLength":10,
            "description":"Customer Contact ID"
        }
    }
}

Nested Schema : _data

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "serviceAgreement":{
                "type":"object",
                "properties":{
                    "serviceAgreementId":{
                        "type":"string",
                        "maxLength":10,
                        "description":"Service Agreement"
                    }
                }
            },
            "writeOffSAStatus":{
                "type":"string",
                "enum":[
                    "10  ",
                    "20  "
                ],
                "description":"Write Off SA Status defines the state of the service agreement in respect of the write-off process.\n* `10  ` - Active,\n* `20  ` - Inactive",
                "example":"10"
            },
            "version":{
                "type":"number",
                "maximum":99999,
                "minimum":-99999,
                "description":"Version"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• 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 ` - Inactive

  Example: 10

{
    "type":"object",
    "properties":{
        "serviceAgreement":{
            "type":"object",
            "properties":{
                "serviceAgreementId":{
                    "type":"string",
                    "maxLength":10,
                    "description":"Service Agreement"
                }
            }
        },
        "writeOffSAStatus":{
            "type":"string",
            "enum":[
                "10  ",
                "20  "
            ],
            "description":"Write Off SA Status defines the state of the service agreement in respect of the write-off process.\n* `10  ` - Active,\n* `20  ` - Inactive",
            "example":"10"
        },
        "version":{
            "type":"number",
            "maximum":99999,
            "minimum":-99999,
            "description":"Version"
        }
    }
}

Nested Schema : serviceAgreement

Type: object

Show Source

• serviceAgreementId: string
  Maximum Length: 10

  Service Agreement

{
    "type":"object",
    "properties":{
        "serviceAgreementId":{
            "type":"string",
            "maxLength":10,
            "description":"Service Agreement"
        }
    }
}

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• 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
• 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 ` - Inactive

  Example: 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 User

  Example: 20

{
    "type":"object",
    "properties":{
        "writeOffProcessId":{
            "type":"string",
            "maxLength":10,
            "description":"Write Off Process ID is the unique system-generated identifier for this write-off process."
        },
        "account":{
            "type":"object",
            "properties":{
                "accountId":{
                    "type":"string",
                    "maxLength":10,
                    "description":"Account ID"
                }
            }
        },
        "writeOffProcessTemplate":{
            "type":"object",
            "description":"Write Off Process Template defines the write-off events in the process.",
            "properties":{
                "writeOffProcessTemplate":{
                    "type":"string",
                    "maxLength":12,
                    "description":"Write Off Process Template"
                }
            }
        },
        "writeOffStatus":{
            "type":"string",
            "enum":[
                "10  ",
                "20  "
            ],
            "description":"Write-off Status defines the state of the write-off process.\n* `10  ` - Active,\n* `20  ` - Inactive",
            "example":"20"
        },
        "writeOffControl":{
            "type":"object",
            "description":"Write Off Control defines the write-off debt class (i.e., the type of debt) associated with the write-off process.",
            "properties":{
                "writeOffControl":{
                    "type":"string",
                    "maxLength":20,
                    "description":"Write Off Control defines the write-off debt class (i.e., the type of debt) associated with the write-off process.",
                    "example":"RES-REGU"
                }
            }
        },
        "writeOffStatusReason":{
            "type":"string",
            "enum":[
                "10  ",
                "20  ",
                "30  ",
                "40  "
            ],
            "description":"Reason defines how a write-off process became Inactive or why a write-off process is Active.\n* `10  ` - Events Pending,\n* `20  ` - Completed,\n* `30  ` - Canceled by System,\n* `40  ` - Canceled by User",
            "example":"20"
        },
        "creationDateTime":{
            "type":"string",
            "format":"date-time",
            "description":"Create Date/Time defines the start date/time of the write-off process.",
            "example":"2005-04-18T07:50:51-04:00"
        },
        "comments":{
            "type":"string",
            "maxLength":254,
            "description":"Enter any Comments about the write-off process.",
            "example":"TESTQA"
        },
        "version":{
            "type":"number",
            "maximum":99999,
            "minimum":-99999,
            "description":"Version"
        },
        "SAs":{
            "type":"object",
            "properties":{
                "_data":{
                    "type":"array",
                    "items":{
                        "type":"object",
                        "properties":{
                            "serviceAgreement":{
                                "type":"object",
                                "properties":{
                                    "serviceAgreementId":{
                                        "type":"string",
                                        "maxLength":10,
                                        "description":"Service Agreement"
                                    }
                                }
                            },
                            "writeOffSAStatus":{
                                "type":"string",
                                "enum":[
                                    "10  ",
                                    "20  "
                                ],
                                "description":"Write Off SA Status defines the state of the service agreement in respect of the write-off process.\n* `10  ` - Active,\n* `20  ` - Inactive",
                                "example":"10"
                            },
                            "version":{
                                "type":"number",
                                "maximum":99999,
                                "minimum":-99999,
                                "description":"Version"
                            }
                        }
                    }
                }
            }
        },
        "events":{
            "type":"object",
            "properties":{
                "_data":{
                    "type":"array",
                    "items":{
                        "type":"object",
                        "properties":{
                            "eventSequence":{
                                "type":"number",
                                "maximum":999,
                                "minimum":-999,
                                "description":"Event Sequence is the unique identifier of the event.",
                                "example":"10"
                            },
                            "writeOffEventStatus":{
                                "type":"string",
                                "enum":[
                                    "10  ",
                                    "30  ",
                                    "40  "
                                ],
                                "description":"Write Off Event Status defines the state of the event.\n* `10  ` - Pending,\n* `30  ` - Completed,\n* `40  ` - Canceled",
                                "example":"10"
                            },
                            "writeOffEventType":{
                                "type":"object",
                                "properties":{
                                    "writeOffEventType":{
                                        "type":"string",
                                        "maxLength":12,
                                        "description":"Write Off Event Type"
                                    }
                                }
                            },
                            "triggerDate":{
                                "type":"string",
                                "format":"date",
                                "description":"The Trigger Date defines the date when the system completes (i.e., executes) the event.",
                                "example":"2009-03-13"
                            },
                            "completionDate":{
                                "type":"string",
                                "format":"date",
                                "description":"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"
                            },
                            "version":{
                                "type":"number",
                                "maximum":99999,
                                "minimum":-99999,
                                "description":"Version"
                            },
                            "eventCustomerContact":{
                                "type":"object",
                                "properties":{
                                    "_data":{
                                        "type":"array",
                                        "items":{
                                            "type":"object",
                                            "properties":{
                                                "customerContact":{
                                                    "type":"object",
                                                    "properties":{
                                                        "customerContactId":{
                                                            "type":"string",
                                                            "maxLength":10,
                                                            "description":"Customer Contact ID"
                                                        }
                                                    }
                                                },
                                                "version":{
                                                    "type":"number",
                                                    "maximum":99999,
                                                    "minimum":-99999,
                                                    "description":"Version"
                                                }
                                            }
                                        }
                                    }
                                }
                            }
                        }
                    }
                }
            }
        }
    },
    "xml":{
        "name":"C1WriteOffPr"
    }
}

Nested Schema : account

Type: object

Show Source

• accountId: string
  Maximum Length: 10

  Account ID

{
    "type":"object",
    "properties":{
        "accountId":{
            "type":"string",
            "maxLength":10,
            "description":"Account ID"
        }
    }
}

Nested Schema : events

Type: object

Show Source

• _data: array _data

{
    "type":"object",
    "properties":{
        "_data":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "eventSequence":{
                        "type":"number",
                        "maximum":999,
                        "minimum":-999,
                        "description":"Event Sequence is the unique identifier of the event.",
                        "example":"10"
                    },
                    "writeOffEventStatus":{
                        "type":"string",
                        "enum":[
                            "10  ",
                            "30  ",
                            "40  "
                        ],
                        "description":"Write Off Event Status defines the state of the event.\n* `10  ` - Pending,\n* `30  ` - Completed,\n* `40  ` - Canceled",
                        "example":"10"
                    },
                    "writeOffEventType":{
                        "type":"object",
                        "properties":{
                            "writeOffEventType":{
                                "type":"string",
                                "maxLength":12,
                                "description":"Write Off Event Type"
                            }
                        }
                    },
                    "triggerDate":{
                        "type":"string",
                        "format":"date",
                        "description":"The Trigger Date defines the date when the system completes (i.e., executes) the event.",
                        "example":"2009-03-13"
                    },
                    "completionDate":{
                        "type":"string",
                        "format":"date",
                        "description":"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"
                    },
                    "version":{
                        "type":"number",
                        "maximum":99999,
                        "minimum":-99999,
                        "description":"Version"
                    },
                    "eventCustomerContact":{
                        "type":"object",
                        "properties":{
                            "_data":{
                                "type":"array",
                                "items":{
                                    "type":"object",
                                    "properties":{
                                        "customerContact":{
                                            "type":"object",
                                            "properties":{
                                                "customerContactId":{
                                                    "type":"string",
                                                    "maxLength":10,
                                                    "description":"Customer Contact ID"
                                                }
                                            }
                                        },
                                        "version":{
                                            "type":"number",
                                            "maximum":99999,
                                            "minimum":-99999,
                                            "description":"Version"
                                        }
                                    }
                                }
                            }
                        }
                    }
                }
            }
        }
    }
}

Nested Schema : SAs

Type: object

Show Source

• _data: array _data

{
    "type":"object",
    "properties":{
        "_data":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "serviceAgreement":{
                        "type":"object",
                        "properties":{
                            "serviceAgreementId":{
                                "type":"string",
                                "maxLength":10,
                                "description":"Service Agreement"
                            }
                        }
                    },
                    "writeOffSAStatus":{
                        "type":"string",
                        "enum":[
                            "10  ",
                            "20  "
                        ],
                        "description":"Write Off SA Status defines the state of the service agreement in respect of the write-off process.\n* `10  ` - Active,\n* `20  ` - Inactive",
                        "example":"10"
                    },
                    "version":{
                        "type":"number",
                        "maximum":99999,
                        "minimum":-99999,
                        "description":"Version"
                    }
                }
            }
        }
    }
}

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

• 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

{
    "type":"object",
    "description":"Write Off Control defines the write-off debt class (i.e., the type of debt) associated with the write-off process.",
    "properties":{
        "writeOffControl":{
            "type":"string",
            "maxLength":20,
            "description":"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

• writeOffProcessTemplate: string
  Maximum Length: 12

  Write Off Process Template

{
    "type":"object",
    "description":"Write Off Process Template defines the write-off events in the process.",
    "properties":{
        "writeOffProcessTemplate":{
            "type":"string",
            "maxLength":12,
            "description":"Write Off Process Template"
        }
    }
}

Nested Schema : _data

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "eventSequence":{
                "type":"number",
                "maximum":999,
                "minimum":-999,
                "description":"Event Sequence is the unique identifier of the event.",
                "example":"10"
            },
            "writeOffEventStatus":{
                "type":"string",
                "enum":[
                    "10  ",
                    "30  ",
                    "40  "
                ],
                "description":"Write Off Event Status defines the state of the event.\n* `10  ` - Pending,\n* `30  ` - Completed,\n* `40  ` - Canceled",
                "example":"10"
            },
            "writeOffEventType":{
                "type":"object",
                "properties":{
                    "writeOffEventType":{
                        "type":"string",
                        "maxLength":12,
                        "description":"Write Off Event Type"
                    }
                }
            },
            "triggerDate":{
                "type":"string",
                "format":"date",
                "description":"The Trigger Date defines the date when the system completes (i.e., executes) the event.",
                "example":"2009-03-13"
            },
            "completionDate":{
                "type":"string",
                "format":"date",
                "description":"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"
            },
            "version":{
                "type":"number",
                "maximum":99999,
                "minimum":-99999,
                "description":"Version"
            },
            "eventCustomerContact":{
                "type":"object",
                "properties":{
                    "_data":{
                        "type":"array",
                        "items":{
                            "type":"object",
                            "properties":{
                                "customerContact":{
                                    "type":"object",
                                    "properties":{
                                        "customerContactId":{
                                            "type":"string",
                                            "maxLength":10,
                                            "description":"Customer Contact ID"
                                        }
                                    }
                                },
                                "version":{
                                    "type":"number",
                                    "maximum":99999,
                                    "minimum":-99999,
                                    "description":"Version"
                                }
                            }
                        }
                    }
                }
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• 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 ` - Canceled

  Example: 10
• writeOffEventType: object writeOffEventType

{
    "type":"object",
    "properties":{
        "eventSequence":{
            "type":"number",
            "maximum":999,
            "minimum":-999,
            "description":"Event Sequence is the unique identifier of the event.",
            "example":"10"
        },
        "writeOffEventStatus":{
            "type":"string",
            "enum":[
                "10  ",
                "30  ",
                "40  "
            ],
            "description":"Write Off Event Status defines the state of the event.\n* `10  ` - Pending,\n* `30  ` - Completed,\n* `40  ` - Canceled",
            "example":"10"
        },
        "writeOffEventType":{
            "type":"object",
            "properties":{
                "writeOffEventType":{
                    "type":"string",
                    "maxLength":12,
                    "description":"Write Off Event Type"
                }
            }
        },
        "triggerDate":{
            "type":"string",
            "format":"date",
            "description":"The Trigger Date defines the date when the system completes (i.e., executes) the event.",
            "example":"2009-03-13"
        },
        "completionDate":{
            "type":"string",
            "format":"date",
            "description":"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"
        },
        "version":{
            "type":"number",
            "maximum":99999,
            "minimum":-99999,
            "description":"Version"
        },
        "eventCustomerContact":{
            "type":"object",
            "properties":{
                "_data":{
                    "type":"array",
                    "items":{
                        "type":"object",
                        "properties":{
                            "customerContact":{
                                "type":"object",
                                "properties":{
                                    "customerContactId":{
                                        "type":"string",
                                        "maxLength":10,
                                        "description":"Customer Contact ID"
                                    }
                                }
                            },
                            "version":{
                                "type":"number",
                                "maximum":99999,
                                "minimum":-99999,
                                "description":"Version"
                            }
                        }
                    }
                }
            }
        }
    }
}

Nested Schema : eventCustomerContact

Type: object

Show Source

• _data: array _data

{
    "type":"object",
    "properties":{
        "_data":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "customerContact":{
                        "type":"object",
                        "properties":{
                            "customerContactId":{
                                "type":"string",
                                "maxLength":10,
                                "description":"Customer Contact ID"
                            }
                        }
                    },
                    "version":{
                        "type":"number",
                        "maximum":99999,
                        "minimum":-99999,
                        "description":"Version"
                    }
                }
            }
        }
    }
}

Nested Schema : writeOffEventType

Type: object

Show Source

• writeOffEventType: string
  Maximum Length: 12

  Write Off Event Type

{
    "type":"object",
    "properties":{
        "writeOffEventType":{
            "type":"string",
            "maxLength":12,
            "description":"Write Off Event Type"
        }
    }
}

Nested Schema : _data

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "customerContact":{
                "type":"object",
                "properties":{
                    "customerContactId":{
                        "type":"string",
                        "maxLength":10,
                        "description":"Customer Contact ID"
                    }
                }
            },
            "version":{
                "type":"number",
                "maximum":99999,
                "minimum":-99999,
                "description":"Version"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• customerContact: object customerContact
• version: number
  Minimum Value: -99999

  Maximum Value: 99999

  Version

{
    "type":"object",
    "properties":{
        "customerContact":{
            "type":"object",
            "properties":{
                "customerContactId":{
                    "type":"string",
                    "maxLength":10,
                    "description":"Customer Contact ID"
                }
            }
        },
        "version":{
            "type":"number",
            "maximum":99999,
            "minimum":-99999,
            "description":"Version"
        }
    }
}

Nested Schema : customerContact

Type: object

Show Source

• customerContactId: string
  Maximum Length: 10

  Customer Contact ID

{
    "type":"object",
    "properties":{
        "customerContactId":{
            "type":"string",
            "maxLength":10,
            "description":"Customer Contact ID"
        }
    }
}

Nested Schema : _data

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "serviceAgreement":{
                "type":"object",
                "properties":{
                    "serviceAgreementId":{
                        "type":"string",
                        "maxLength":10,
                        "description":"Service Agreement"
                    }
                }
            },
            "writeOffSAStatus":{
                "type":"string",
                "enum":[
                    "10  ",
                    "20  "
                ],
                "description":"Write Off SA Status defines the state of the service agreement in respect of the write-off process.\n* `10  ` - Active,\n* `20  ` - Inactive",
                "example":"10"
            },
            "version":{
                "type":"number",
                "maximum":99999,
                "minimum":-99999,
                "description":"Version"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• 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 ` - Inactive

  Example: 10

{
    "type":"object",
    "properties":{
        "serviceAgreement":{
            "type":"object",
            "properties":{
                "serviceAgreementId":{
                    "type":"string",
                    "maxLength":10,
                    "description":"Service Agreement"
                }
            }
        },
        "writeOffSAStatus":{
            "type":"string",
            "enum":[
                "10  ",
                "20  "
            ],
            "description":"Write Off SA Status defines the state of the service agreement in respect of the write-off process.\n* `10  ` - Active,\n* `20  ` - Inactive",
            "example":"10"
        },
        "version":{
            "type":"number",
            "maximum":99999,
            "minimum":-99999,
            "description":"Version"
        }
    }
}

Nested Schema : serviceAgreement

Type: object

Show Source

• serviceAgreementId: string
  Maximum Length: 10

  Service Agreement

{
    "type":"object",
    "properties":{
        "serviceAgreementId":{
            "type":"string",
            "maxLength":10,
            "description":"Service Agreement"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/xml
• application/json

200 Response

Success response

Body ()

Root Schema : C1WriteOffPr

Type: object

Show Source

• _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
• 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 ` - Inactive

  Example: 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 User

  Example: 20

{
    "type":"object",
    "properties":{
        "_self":{
            "type":"string",
            "description":"_self"
        },
        "writeOffProcessId":{
            "type":"string",
            "maxLength":10,
            "description":"Write Off Process ID is the unique system-generated identifier for this write-off process."
        },
        "account":{
            "type":"object",
            "properties":{
                "_link":{
                    "type":"string",
                    "description":"_link"
                },
                "accountId":{
                    "type":"string",
                    "maxLength":10,
                    "description":"Account ID"
                }
            }
        },
        "writeOffProcessTemplate":{
            "type":"object",
            "description":"Write Off Process Template defines the write-off events in the process.",
            "properties":{
                "_link":{
                    "type":"string",
                    "description":"_link"
                },
                "writeOffProcessTemplate":{
                    "type":"string",
                    "maxLength":12,
                    "description":"Write Off Process Template"
                }
            }
        },
        "writeOffStatus":{
            "type":"string",
            "enum":[
                "10  ",
                "20  "
            ],
            "description":"Write-off Status defines the state of the write-off process.\n* `10  ` - Active,\n* `20  ` - Inactive",
            "example":"20"
        },
        "writeOffControl":{
            "type":"object",
            "description":"Write Off Control defines the write-off debt class (i.e., the type of debt) associated with the write-off process.",
            "properties":{
                "_link":{
                    "type":"string",
                    "description":"_link"
                },
                "writeOffControl":{
                    "type":"string",
                    "maxLength":20,
                    "description":"Write Off Control defines the write-off debt class (i.e., the type of debt) associated with the write-off process.",
                    "example":"RES-REGU"
                }
            }
        },
        "writeOffStatusReason":{
            "type":"string",
            "enum":[
                "10  ",
                "20  ",
                "30  ",
                "40  "
            ],
            "description":"Reason defines how a write-off process became Inactive or why a write-off process is Active.\n* `10  ` - Events Pending,\n* `20  ` - Completed,\n* `30  ` - Canceled by System,\n* `40  ` - Canceled by User",
            "example":"20"
        },
        "creationDateTime":{
            "type":"string",
            "format":"date-time",
            "description":"Create Date/Time defines the start date/time of the write-off process.",
            "example":"2005-04-18T07:50:51-04:00"
        },
        "comments":{
            "type":"string",
            "maxLength":254,
            "description":"Enter any Comments about the write-off process.",
            "example":"TESTQA"
        },
        "version":{
            "type":"number",
            "maximum":99999,
            "minimum":-99999,
            "description":"Version"
        },
        "SAs":{
            "type":"object",
            "properties":{
                "_data":{
                    "type":"array",
                    "items":{
                        "type":"object",
                        "properties":{
                            "serviceAgreement":{
                                "type":"object",
                                "properties":{
                                    "_link":{
                                        "type":"string",
                                        "description":"_link"
                                    },
                                    "serviceAgreementId":{
                                        "type":"string",
                                        "maxLength":10,
                                        "description":"Service Agreement"
                                    }
                                }
                            },
                            "writeOffSAStatus":{
                                "type":"string",
                                "enum":[
                                    "10  ",
                                    "20  "
                                ],
                                "description":"Write Off SA Status defines the state of the service agreement in respect of the write-off process.\n* `10  ` - Active,\n* `20  ` - Inactive",
                                "example":"10"
                            },
                            "version":{
                                "type":"number",
                                "maximum":99999,
                                "minimum":-99999,
                                "description":"Version"
                            }
                        }
                    }
                }
            }
        },
        "events":{
            "type":"object",
            "properties":{
                "_data":{
                    "type":"array",
                    "items":{
                        "type":"object",
                        "properties":{
                            "eventSequence":{
                                "type":"number",
                                "maximum":999,
                                "minimum":-999,
                                "description":"Event Sequence is the unique identifier of the event.",
                                "example":"10"
                            },
                            "writeOffEventStatus":{
                                "type":"string",
                                "enum":[
                                    "10  ",
                                    "30  ",
                                    "40  "
                                ],
                                "description":"Write Off Event Status defines the state of the event.\n* `10  ` - Pending,\n* `30  ` - Completed,\n* `40  ` - Canceled",
                                "example":"10"
                            },
                            "writeOffEventType":{
                                "type":"object",
                                "properties":{
                                    "_link":{
                                        "type":"string",
                                        "description":"_link"
                                    },
                                    "writeOffEventType":{
                                        "type":"string",
                                        "maxLength":12,
                                        "description":"Write Off Event Type"
                                    }
                                }
                            },
                            "triggerDate":{
                                "type":"string",
                                "format":"date",
                                "description":"The Trigger Date defines the date when the system completes (i.e., executes) the event.",
                                "example":"2009-03-13"
                            },
                            "completionDate":{
                                "type":"string",
                                "format":"date",
                                "description":"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"
                            },
                            "version":{
                                "type":"number",
                                "maximum":99999,
                                "minimum":-99999,
                                "description":"Version"
                            },
                            "eventCustomerContact":{
                                "type":"object",
                                "properties":{
                                    "_data":{
                                        "type":"array",
                                        "items":{
                                            "type":"object",
                                            "properties":{
                                                "customerContact":{
                                                    "type":"object",
                                                    "properties":{
                                                        "_link":{
                                                            "type":"string",
                                                            "description":"_link"
                                                        },
                                                        "customerContactId":{
                                                            "type":"string",
                                                            "maxLength":10,
                                                            "description":"Customer Contact ID"
                                                        }
                                                    }
                                                },
                                                "version":{
                                                    "type":"number",
                                                    "maximum":99999,
                                                    "minimum":-99999,
                                                    "description":"Version"
                                                }
                                            }
                                        }
                                    }
                                }
                            }
                        }
                    }
                }
            }
        }
    },
    "xml":{
        "name":"C1WriteOffPr"
    }
}

Nested Schema : account

Type: object

Show Source

• _link: string
  _link
• accountId: string
  Maximum Length: 10

  Account ID

{
    "type":"object",
    "properties":{
        "_link":{
            "type":"string",
            "description":"_link"
        },
        "accountId":{
            "type":"string",
            "maxLength":10,
            "description":"Account ID"
        }
    }
}

Nested Schema : events

Type: object

Show Source

• _data: array _data

{
    "type":"object",
    "properties":{
        "_data":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "eventSequence":{
                        "type":"number",
                        "maximum":999,
                        "minimum":-999,
                        "description":"Event Sequence is the unique identifier of the event.",
                        "example":"10"
                    },
                    "writeOffEventStatus":{
                        "type":"string",
                        "enum":[
                            "10  ",
                            "30  ",
                            "40  "
                        ],
                        "description":"Write Off Event Status defines the state of the event.\n* `10  ` - Pending,\n* `30  ` - Completed,\n* `40  ` - Canceled",
                        "example":"10"
                    },
                    "writeOffEventType":{
                        "type":"object",
                        "properties":{
                            "_link":{
                                "type":"string",
                                "description":"_link"
                            },
                            "writeOffEventType":{
                                "type":"string",
                                "maxLength":12,
                                "description":"Write Off Event Type"
                            }
                        }
                    },
                    "triggerDate":{
                        "type":"string",
                        "format":"date",
                        "description":"The Trigger Date defines the date when the system completes (i.e., executes) the event.",
                        "example":"2009-03-13"
                    },
                    "completionDate":{
                        "type":"string",
                        "format":"date",
                        "description":"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"
                    },
                    "version":{
                        "type":"number",
                        "maximum":99999,
                        "minimum":-99999,
                        "description":"Version"
                    },
                    "eventCustomerContact":{
                        "type":"object",
                        "properties":{
                            "_data":{
                                "type":"array",
                                "items":{
                                    "type":"object",
                                    "properties":{
                                        "customerContact":{
                                            "type":"object",
                                            "properties":{
                                                "_link":{
                                                    "type":"string",
                                                    "description":"_link"
                                                },
                                                "customerContactId":{
                                                    "type":"string",
                                                    "maxLength":10,
                                                    "description":"Customer Contact ID"
                                                }
                                            }
                                        },
                                        "version":{
                                            "type":"number",
                                            "maximum":99999,
                                            "minimum":-99999,
                                            "description":"Version"
                                        }
                                    }
                                }
                            }
                        }
                    }
                }
            }
        }
    }
}

Nested Schema : SAs

Type: object

Show Source

• _data: array _data

{
    "type":"object",
    "properties":{
        "_data":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "serviceAgreement":{
                        "type":"object",
                        "properties":{
                            "_link":{
                                "type":"string",
                                "description":"_link"
                            },
                            "serviceAgreementId":{
                                "type":"string",
                                "maxLength":10,
                                "description":"Service Agreement"
                            }
                        }
                    },
                    "writeOffSAStatus":{
                        "type":"string",
                        "enum":[
                            "10  ",
                            "20  "
                        ],
                        "description":"Write Off SA Status defines the state of the service agreement in respect of the write-off process.\n* `10  ` - Active,\n* `20  ` - Inactive",
                        "example":"10"
                    },
                    "version":{
                        "type":"number",
                        "maximum":99999,
                        "minimum":-99999,
                        "description":"Version"
                    }
                }
            }
        }
    }
}

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

{
    "type":"object",
    "description":"Write Off Control defines the write-off debt class (i.e., the type of debt) associated with the write-off process.",
    "properties":{
        "_link":{
            "type":"string",
            "description":"_link"
        },
        "writeOffControl":{
            "type":"string",
            "maxLength":20,
            "description":"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

{
    "type":"object",
    "description":"Write Off Process Template defines the write-off events in the process.",
    "properties":{
        "_link":{
            "type":"string",
            "description":"_link"
        },
        "writeOffProcessTemplate":{
            "type":"string",
            "maxLength":12,
            "description":"Write Off Process Template"
        }
    }
}

Nested Schema : _data

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "eventSequence":{
                "type":"number",
                "maximum":999,
                "minimum":-999,
                "description":"Event Sequence is the unique identifier of the event.",
                "example":"10"
            },
            "writeOffEventStatus":{
                "type":"string",
                "enum":[
                    "10  ",
                    "30  ",
                    "40  "
                ],
                "description":"Write Off Event Status defines the state of the event.\n* `10  ` - Pending,\n* `30  ` - Completed,\n* `40  ` - Canceled",
                "example":"10"
            },
            "writeOffEventType":{
                "type":"object",
                "properties":{
                    "_link":{
                        "type":"string",
                        "description":"_link"
                    },
                    "writeOffEventType":{
                        "type":"string",
                        "maxLength":12,
                        "description":"Write Off Event Type"
                    }
                }
            },
            "triggerDate":{
                "type":"string",
                "format":"date",
                "description":"The Trigger Date defines the date when the system completes (i.e., executes) the event.",
                "example":"2009-03-13"
            },
            "completionDate":{
                "type":"string",
                "format":"date",
                "description":"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"
            },
            "version":{
                "type":"number",
                "maximum":99999,
                "minimum":-99999,
                "description":"Version"
            },
            "eventCustomerContact":{
                "type":"object",
                "properties":{
                    "_data":{
                        "type":"array",
                        "items":{
                            "type":"object",
                            "properties":{
                                "customerContact":{
                                    "type":"object",
                                    "properties":{
                                        "_link":{
                                            "type":"string",
                                            "description":"_link"
                                        },
                                        "customerContactId":{
                                            "type":"string",
                                            "maxLength":10,
                                            "description":"Customer Contact ID"
                                        }
                                    }
                                },
                                "version":{
                                    "type":"number",
                                    "maximum":99999,
                                    "minimum":-99999,
                                    "description":"Version"
                                }
                            }
                        }
                    }
                }
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• 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 ` - Canceled

  Example: 10
• writeOffEventType: object writeOffEventType

{
    "type":"object",
    "properties":{
        "eventSequence":{
            "type":"number",
            "maximum":999,
            "minimum":-999,
            "description":"Event Sequence is the unique identifier of the event.",
            "example":"10"
        },
        "writeOffEventStatus":{
            "type":"string",
            "enum":[
                "10  ",
                "30  ",
                "40  "
            ],
            "description":"Write Off Event Status defines the state of the event.\n* `10  ` - Pending,\n* `30  ` - Completed,\n* `40  ` - Canceled",
            "example":"10"
        },
        "writeOffEventType":{
            "type":"object",
            "properties":{
                "_link":{
                    "type":"string",
                    "description":"_link"
                },
                "writeOffEventType":{
                    "type":"string",
                    "maxLength":12,
                    "description":"Write Off Event Type"
                }
            }
        },
        "triggerDate":{
            "type":"string",
            "format":"date",
            "description":"The Trigger Date defines the date when the system completes (i.e., executes) the event.",
            "example":"2009-03-13"
        },
        "completionDate":{
            "type":"string",
            "format":"date",
            "description":"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"
        },
        "version":{
            "type":"number",
            "maximum":99999,
            "minimum":-99999,
            "description":"Version"
        },
        "eventCustomerContact":{
            "type":"object",
            "properties":{
                "_data":{
                    "type":"array",
                    "items":{
                        "type":"object",
                        "properties":{
                            "customerContact":{
                                "type":"object",
                                "properties":{
                                    "_link":{
                                        "type":"string",
                                        "description":"_link"
                                    },
                                    "customerContactId":{
                                        "type":"string",
                                        "maxLength":10,
                                        "description":"Customer Contact ID"
                                    }
                                }
                            },
                            "version":{
                                "type":"number",
                                "maximum":99999,
                                "minimum":-99999,
                                "description":"Version"
                            }
                        }
                    }
                }
            }
        }
    }
}

Nested Schema : eventCustomerContact

Type: object

Show Source

• _data: array _data

{
    "type":"object",
    "properties":{
        "_data":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "customerContact":{
                        "type":"object",
                        "properties":{
                            "_link":{
                                "type":"string",
                                "description":"_link"
                            },
                            "customerContactId":{
                                "type":"string",
                                "maxLength":10,
                                "description":"Customer Contact ID"
                            }
                        }
                    },
                    "version":{
                        "type":"number",
                        "maximum":99999,
                        "minimum":-99999,
                        "description":"Version"
                    }
                }
            }
        }
    }
}

Nested Schema : writeOffEventType

Type: object

Show Source

• _link: string
  _link
• writeOffEventType: string
  Maximum Length: 12

  Write Off Event Type

{
    "type":"object",
    "properties":{
        "_link":{
            "type":"string",
            "description":"_link"
        },
        "writeOffEventType":{
            "type":"string",
            "maxLength":12,
            "description":"Write Off Event Type"
        }
    }
}

Nested Schema : _data

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "customerContact":{
                "type":"object",
                "properties":{
                    "_link":{
                        "type":"string",
                        "description":"_link"
                    },
                    "customerContactId":{
                        "type":"string",
                        "maxLength":10,
                        "description":"Customer Contact ID"
                    }
                }
            },
            "version":{
                "type":"number",
                "maximum":99999,
                "minimum":-99999,
                "description":"Version"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• customerContact: object customerContact
• version: number
  Minimum Value: -99999

  Maximum Value: 99999

  Version

{
    "type":"object",
    "properties":{
        "customerContact":{
            "type":"object",
            "properties":{
                "_link":{
                    "type":"string",
                    "description":"_link"
                },
                "customerContactId":{
                    "type":"string",
                    "maxLength":10,
                    "description":"Customer Contact ID"
                }
            }
        },
        "version":{
            "type":"number",
            "maximum":99999,
            "minimum":-99999,
            "description":"Version"
        }
    }
}

Nested Schema : customerContact

Type: object

Show Source

• _link: string
  _link
• customerContactId: string
  Maximum Length: 10

  Customer Contact ID

{
    "type":"object",
    "properties":{
        "_link":{
            "type":"string",
            "description":"_link"
        },
        "customerContactId":{
            "type":"string",
            "maxLength":10,
            "description":"Customer Contact ID"
        }
    }
}

Nested Schema : _data

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "serviceAgreement":{
                "type":"object",
                "properties":{
                    "_link":{
                        "type":"string",
                        "description":"_link"
                    },
                    "serviceAgreementId":{
                        "type":"string",
                        "maxLength":10,
                        "description":"Service Agreement"
                    }
                }
            },
            "writeOffSAStatus":{
                "type":"string",
                "enum":[
                    "10  ",
                    "20  "
                ],
                "description":"Write Off SA Status defines the state of the service agreement in respect of the write-off process.\n* `10  ` - Active,\n* `20  ` - Inactive",
                "example":"10"
            },
            "version":{
                "type":"number",
                "maximum":99999,
                "minimum":-99999,
                "description":"Version"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• 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 ` - Inactive

  Example: 10

{
    "type":"object",
    "properties":{
        "serviceAgreement":{
            "type":"object",
            "properties":{
                "_link":{
                    "type":"string",
                    "description":"_link"
                },
                "serviceAgreementId":{
                    "type":"string",
                    "maxLength":10,
                    "description":"Service Agreement"
                }
            }
        },
        "writeOffSAStatus":{
            "type":"string",
            "enum":[
                "10  ",
                "20  "
            ],
            "description":"Write Off SA Status defines the state of the service agreement in respect of the write-off process.\n* `10  ` - Active,\n* `20  ` - Inactive",
            "example":"10"
        },
        "version":{
            "type":"number",
            "maximum":99999,
            "minimum":-99999,
            "description":"Version"
        }
    }
}

Nested Schema : serviceAgreement

Type: object

Show Source

• _link: string
  _link
• serviceAgreementId: string
  Maximum Length: 10

  Service Agreement

{
    "type":"object",
    "properties":{
        "_link":{
            "type":"string",
            "description":"_link"
        },
        "serviceAgreementId":{
            "type":"string",
            "maxLength":10,
            "description":"Service Agreement"
        }
    }
}

400 Response

Bad Request

Body ()

Root Schema : problemDetailDocument

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "problemType":{
            "type":"string",
            "maxLength":60,
            "description":"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."
        },
        "title":{
            "type":"string",
            "maxLength":60,
            "description":"Fully qualified error message from Oracle Utilities Application Framework in CDATA format."
        },
        "httpStatus":{
            "type":"number",
            "maximum":9999,
            "minimum":0,
            "description":"The HTTP Status code for the error."
        },
        "detail":{
            "type":"string",
            "maxLength":60,
            "description":"The long message description from the Oracle Utilities Application Framework in CDATA format."
        },
        "problemInstance":{
            "type":"string",
            "maxLength":60,
            "description":"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."
        },
        "stackTrace":{
            "type":"string",
            "maxLength":60,
            "description":"The stack trace shows where the error occurs during the execution of a program."
        },
        "serverMessage":{
            "type":"object",
            "properties":{
                "messageCategory":{
                    "type":"number",
                    "maximum":0,
                    "minimum":0,
                    "description":"Message Category within Oracle Utilities Application Framework."
                },
                "messageNbr":{
                    "type":"number",
                    "maximum":99999,
                    "minimum":-99999,
                    "description":"Message Number within Oracle Utilities Application Framework."
                },
                "callSequence":{
                    "type":"string",
                    "maxLength":60,
                    "description":"Delimited sequence of programs called."
                },
                "programName":{
                    "type":"string",
                    "maxLength":60,
                    "description":"Name of the program that encountered the error."
                },
                "messageText":{
                    "type":"string",
                    "maxLength":60,
                    "description":"Fully qualified error message from Oracle Utilities Application Framework in CDATA format."
                },
                "longDescription":{
                    "type":"string",
                    "maxLength":60,
                    "description":"The long message description from the Oracle Utilities Application Framework in CDATA format."
                }
            }
        }
    }
}

Nested Schema : serverMessage

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "messageCategory":{
            "type":"number",
            "maximum":0,
            "minimum":0,
            "description":"Message Category within Oracle Utilities Application Framework."
        },
        "messageNbr":{
            "type":"number",
            "maximum":99999,
            "minimum":-99999,
            "description":"Message Number within Oracle Utilities Application Framework."
        },
        "callSequence":{
            "type":"string",
            "maxLength":60,
            "description":"Delimited sequence of programs called."
        },
        "programName":{
            "type":"string",
            "maxLength":60,
            "description":"Name of the program that encountered the error."
        },
        "messageText":{
            "type":"string",
            "maxLength":60,
            "description":"Fully qualified error message from Oracle Utilities Application Framework in CDATA format."
        },
        "longDescription":{
            "type":"string",
            "maxLength":60,
            "description":"The long message description from the Oracle Utilities Application Framework in CDATA format."
        }
    }
}

500 Response

Internal Server Error

Body ()

Root Schema : problemDetailDocument

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "problemType":{
            "type":"string",
            "maxLength":60,
            "description":"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."
        },
        "title":{
            "type":"string",
            "maxLength":60,
            "description":"Fully qualified error message from Oracle Utilities Application Framework in CDATA format."
        },
        "httpStatus":{
            "type":"number",
            "maximum":9999,
            "minimum":0,
            "description":"The HTTP Status code for the error."
        },
        "detail":{
            "type":"string",
            "maxLength":60,
            "description":"The long message description from the Oracle Utilities Application Framework in CDATA format."
        },
        "problemInstance":{
            "type":"string",
            "maxLength":60,
            "description":"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."
        },
        "stackTrace":{
            "type":"string",
            "maxLength":60,
            "description":"The stack trace shows where the error occurs during the execution of a program."
        },
        "serverMessage":{
            "type":"object",
            "properties":{
                "messageCategory":{
                    "type":"number",
                    "maximum":0,
                    "minimum":0,
                    "description":"Message Category within Oracle Utilities Application Framework."
                },
                "messageNbr":{
                    "type":"number",
                    "maximum":99999,
                    "minimum":-99999,
                    "description":"Message Number within Oracle Utilities Application Framework."
                },
                "callSequence":{
                    "type":"string",
                    "maxLength":60,
                    "description":"Delimited sequence of programs called."
                },
                "programName":{
                    "type":"string",
                    "maxLength":60,
                    "description":"Name of the program that encountered the error."
                },
                "messageText":{
                    "type":"string",
                    "maxLength":60,
                    "description":"Fully qualified error message from Oracle Utilities Application Framework in CDATA format."
                },
                "longDescription":{
                    "type":"string",
                    "maxLength":60,
                    "description":"The long message description from the Oracle Utilities Application Framework in CDATA format."
                }
            }
        }
    }
}

Nested Schema : serverMessage

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "messageCategory":{
            "type":"number",
            "maximum":0,
            "minimum":0,
            "description":"Message Category within Oracle Utilities Application Framework."
        },
        "messageNbr":{
            "type":"number",
            "maximum":99999,
            "minimum":-99999,
            "description":"Message Number within Oracle Utilities Application Framework."
        },
        "callSequence":{
            "type":"string",
            "maxLength":60,
            "description":"Delimited sequence of programs called."
        },
        "programName":{
            "type":"string",
            "maxLength":60,
            "description":"Name of the program that encountered the error."
        },
        "messageText":{
            "type":"string",
            "maxLength":60,
            "description":"Fully qualified error message from Oracle Utilities Application Framework in CDATA format."
        },
        "longDescription":{
            "type":"string",
            "maxLength":60,
            "description":"The long message description from the Oracle Utilities Application Framework in CDATA format."
        }
    }
}

Back to Top