Add a Collections Action
post
/bcws/webresources/v1.0/collections/task/insert/{id}
Adds a collections action to a collections scenario.
Request
Path Parameters
-
id(required): string
The ID of the collections action to add, such as 0.0.0.1+-config-collections-action+234.
Supported Media Types
- application/xml
- application/json
Information about the collections action to add.
Root Schema : schema
Type:
Show Source
object
-
amount: number
The amount to collect for the new action.
-
billUnitRef: object
ResourceRef
-
cancelFollowupActions: boolean
Whether to cancel all of the follow-up collections actions (true) or keep the existing follow-up collections actions (false).
-
collectionAgent: string
The agent assigned to the collections action.
-
extension: object
extension
The extended attributes.
-
notes: object
Notes
-
paymentMethodRef: object
ResourceRef
-
slipByDays: integer
(int32)
The number of days to slip the scheduled action.
-
startDate(required): string
(date-time)
The date and time the collections action starts.
Nested Schema : ResourceRef
Type:
Show Source
object
-
id(required): string
The ID.
-
uri: string
The Uniform Resource Identifier (URI) associated with the resource.
Nested Schema : extension
Type:
object
The extended attributes.
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.
Information about the collections action to add.
Root Schema : schema
Type:
Show Source
object
-
amount: number
The amount to collect for the new action.
-
billUnitRef: object
ResourceRef
-
cancelFollowupActions: boolean
Whether to cancel all of the follow-up collections actions (true) or keep the existing follow-up collections actions (false).
-
collectionAgent: string
The agent assigned to the collections action.
-
extension: object
extension
The extended attributes.
-
notes: object
Notes
-
paymentMethodRef: object
ResourceRef
-
slipByDays: integer
(int32)
The number of days to slip the scheduled action.
-
startDate(required): string
(date-time)
The date and time the collections action starts.
Nested Schema : ResourceRef
Type:
Show Source
object
-
id(required): string
The ID.
-
uri: string
The Uniform Resource Identifier (URI) associated with the resource.
Nested Schema : extension
Type:
object
The extended attributes.
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
Supported Media Types
- application/xml
- application/json
200 Response
The collections action was added successfully.
Root Schema : resource
Type:
Show Source
object
-
extension: object
extension
The extended attributes.
-
reference(required): object
ResourceRef
Nested Schema : extension
Type:
object
The extended attributes.
Nested Schema : ResourceRef
Type:
Show Source
object
-
id(required): string
The ID.
-
uri: string
The Uniform Resource Identifier (URI) associated with the resource.
500 Response
An internal server error occurred.
Examples
This example shows how to add a collections action into the collections process for a bill unit by submitting a POST request on the REST resource using cURL. For more information about cURL, see "Use cURL".
cURL Command
curl -X POST 'http://hostname:port/bcws/webresources/version/collections/task/insert/0.0.0.1+-config-collections-action+824' -H 'content-type: application/json' -d @addAction.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.
- addAction.json is the JSON file that specifies the details of the action to add.
Example of Request Body
This example shows the contents of the addAction.json file sent as the request body.
{
"billUnitRef": {
"id": "0.0.0.1+-billinfo+62901"
},
"startDate": "2021-02-05T18:30:00.000Z",
"slipByDays": 0,
"cancelFollowupActions": false,
"notes": {
"billUnitId": "0.0.0.1+-billinfo+62901",
"accountId": "0.0.0.1+-account+65205",
"domainId": 10,
"type": 900,
"subType": 901,
"status": 101,
"effectiveDate": "2021-02-08",
"id": "0.0.0.1+-note+177021",
"reasonId": "3"
"comments": [
{
"comment": "Customer could not be reached, referring to outside agency."
}
]
}
}
Example of Response Body
This example shows the contents of the response body in JSON format.
{
"extension": null,
"reference": {
"id": "0.0.0.1+-collections_action-refer_to_outside_agency+258523",
"uri": "http://hostname:port/bcws/webresources/v1.0/collections/0.0.0.1+-collections_action-refer_to_outside_agency+258523"
}
}