Replace the Collections Scenario for a Bill Unit
put
/bcws/webresources/v1.0/collections/scenario/replace/{id}
Replaces a bill unit's existing collection scenario with a new collections scenario.
Request
Path Parameters
-
id(required): string
The ID of the bill unit.
Supported Media Types
- application/xml
- application/json
Details about the old and new collections scenarios. It also contains the date from when new scenario has to be scheduled.
Root Schema : schema
Type:
Show Source
object
-
considerEntryDays: integer
(int32)
When calculating the due date for new scenario actions, whether to ignore the new collections scenario entry days (0) or to use the new entry days (1).
-
notes: object
Notes
-
scenarioFromID: string
The ID of the old collections scenario that is being replaced.
-
scenarioToID: string
The ID of the new collections scenario.
-
scheduleDate: string
(date-time)
The date and time the new scenario actions are to be scheduled. This field is relevant only if the schedule mode is set to the user billing date. If no date is passed in and the schedule mode is user billing date, the scenario actions are scheduled for the current date.
-
scheduleMode: integer
(int32)
The collections scheduling mode, such as billing due date or user billing date.
Nested Schema : Notes
Type:
Show Source
object
-
accountId(required): string
The ID of the account associated with the note.
-
amount: number
The amount associated with the note. It can be a payment amount, adjustment amount, or so on.
-
billId: string
The ID of the bill associated with the note.
-
billUnitId: string
The ID of the bill unit associated with the note.
-
closedDate: string
(date-time)
The date and time the note was resolved.
-
comments: array
comments
The list of comments associated with the note.
-
count: integer
(int32)
The number of comments associated with the note.
-
domainId: integer
(int32)
The domain ID associated with the note.
-
effectiveDate: string
(date-time)
The date and time the comment was posted.
-
eventId: string
The ID of the event associated with the note.
-
extension: object
extension
The extended attributes.
-
header: string
The header associated with the note.
-
id: string
The ID.
-
itemId: string
The ID of the item associated with the note.
-
reasonId: integer
(int32)
The reason ID associated with the note. Possible values are stored in /config/reason_code_scope objects. See Localizing and Customizing Strings in BRM Developer's Guide for information about how to customize these values using the reasons.locale file.
-
serviceId: string
The service ID associated with the note.
-
status: number
The note's status: not set (100), resolved (101), or unresolved (102). The default value is 102.
-
subType: integer
(int32)
The note's subtype. Possible values are stored in the /config/note_type object. See Localizing and Customizing Strings in BRM Developer's Guide for information about how to customize these values using the note.locale file.
-
type: integer
(int32)
The note's type. Possible values are stored in the /config/note_type object. See Localizing and Customizing Strings in BRM Developer's Guide for information about how to customize these values using the note.locale file.
Nested Schema : comments
Type:
array
The list of comments associated with the note.
Show Source
-
Array of:
object Comments
The list of comments associated with the note.
Nested Schema : extension
Type:
object
The extended attributes.
Nested Schema : Comments
Type:
object
The list of comments associated with the note.
Show Source
-
comment(required): string
The comment.
-
csrAccountId: string
The CSR's account ID.
-
csrFirstName: string
The CSR's first name.
-
csrLastName: string
The CSR's last name.
-
csrLoginId: string
The login ID associated with the CSR.
-
entryDate: string
(date-time)
The date and time the comment was entered by the CSR.
-
externalUser: string
The external user.
-
trackingId: string
The tracking ID.
Details about the old and new collections scenarios. It also contains the date from when new scenario has to be scheduled.
Root Schema : schema
Type:
Show Source
object
-
considerEntryDays: integer
(int32)
When calculating the due date for new scenario actions, whether to ignore the new collections scenario entry days (0) or to use the new entry days (1).
-
notes: object
Notes
-
scenarioFromID: string
The ID of the old collections scenario that is being replaced.
-
scenarioToID: string
The ID of the new collections scenario.
-
scheduleDate: string
(date-time)
The date and time the new scenario actions are to be scheduled. This field is relevant only if the schedule mode is set to the user billing date. If no date is passed in and the schedule mode is user billing date, the scenario actions are scheduled for the current date.
-
scheduleMode: integer
(int32)
The collections scheduling mode, such as billing due date or user billing date.
Nested Schema : Notes
Type:
Show Source
object
-
accountId(required): string
The ID of the account associated with the note.
-
amount: number
The amount associated with the note. It can be a payment amount, adjustment amount, or so on.
-
billId: string
The ID of the bill associated with the note.
-
billUnitId: string
The ID of the bill unit associated with the note.
-
closedDate: string
(date-time)
The date and time the note was resolved.
-
comments: array
comments
The list of comments associated with the note.
-
count: integer
(int32)
The number of comments associated with the note.
-
domainId: integer
(int32)
The domain ID associated with the note.
-
effectiveDate: string
(date-time)
The date and time the comment was posted.
-
eventId: string
The ID of the event associated with the note.
-
extension: object
extension
The extended attributes.
-
header: string
The header associated with the note.
-
id: string
The ID.
-
itemId: string
The ID of the item associated with the note.
-
reasonId: integer
(int32)
The reason ID associated with the note. Possible values are stored in /config/reason_code_scope objects. See Localizing and Customizing Strings in BRM Developer's Guide for information about how to customize these values using the reasons.locale file.
-
serviceId: string
The service ID associated with the note.
-
status: number
The note's status: not set (100), resolved (101), or unresolved (102). The default value is 102.
-
subType: integer
(int32)
The note's subtype. Possible values are stored in the /config/note_type object. See Localizing and Customizing Strings in BRM Developer's Guide for information about how to customize these values using the note.locale file.
-
type: integer
(int32)
The note's type. Possible values are stored in the /config/note_type object. See Localizing and Customizing Strings in BRM Developer's Guide for information about how to customize these values using the note.locale file.
Nested Schema : comments
Type:
array
The list of comments associated with the note.
Show Source
-
Array of:
object Comments
The list of comments associated with the note.
Nested Schema : extension
Type:
object
The extended attributes.
Nested Schema : Comments
Type:
object
The list of comments associated with the note.
Show Source
-
comment(required): string
The comment.
-
csrAccountId: string
The CSR's account ID.
-
csrFirstName: string
The CSR's first name.
-
csrLastName: string
The CSR's last name.
-
csrLoginId: string
The login ID associated with the CSR.
-
entryDate: string
(date-time)
The date and time the comment was entered by the CSR.
-
externalUser: string
The external user.
-
trackingId: string
The tracking ID.
Response
200 Response
The bill unit's collections scenario was replaced successfully.
500 Response
An internal server error occurred.
Examples
This example shows how to replace a bill unit's collections scenario by submitting a PUT request on the REST resource using cURL. For more information about cURL, see "Use cURL".
cURL Command
curl -X PUT 'http://hostname:port/bcws/webresources/version/collections/scenario/replace/0.0.0.1+-billinfo+128084' -H 'content-type: application/json' -d @replaceScenario.json
where:
- hostname is the URL for the Billing Care REST server.
- port is the port for the Billing Care REST server.
- version is the version of the API you're using, such as v1.0.
- replaceScenario.json is the JSON file that specifies the replacement details.
Example of Request Body
This example shows the contents of the replaceScenario.json file sent as the request body.
{
"scenarioFromID": "0.0.0.1+-config-collections-scenario+126171",
"scenarioToID": "0.0.0.1+-config-collections-scenario+168723",
"scheduleMode": "0",
"scheduleDate": "2021-02-08T13:38:10.788Z",
"considerEntryDays": 0,
"notes": {
"billUnitId": "0.0.0.1+-billinfo+128084",
"accountId": "0.0.0.1+-account+130964",
"domainId": 10,
"type": 900,
"subType": 901,
"status": 101,
"effectiveDate": "2021-02-08",
"id": "0.0.0.1+-note+278620",
"comments": [
{
"comment": "Changing bill unit to a different scenario."
}
]
}
}
Example of Response Body
If successful, the response code 200 is returned with true in the response body.