1. REST API Reference for Billing Care
  2. Tasks
  3. Collections

Remove a Bill Unit from Collections

put

/bcws/webresources/v1.0/collections/exit/{id}

Removes the specified bill unit from collections.

Request

Path Parameters
Supported Media Types
Request Body - application/xml ()
Root Schema : schema
Type: object
Show Source
Nested Schema : extension
Type: object
The extended attributes.
Nested Schema : Notes
Type: object
Show Source
Nested Schema : comments
Type: array
The list of comments associated with the note.
Show Source
Nested Schema : extension
Type: object
The extended attributes.
Nested Schema : Comments
Type: object
The list of comments associated with the note.
Show Source
Request Body - application/json ()
Root Schema : schema
Type: object
Show Source
Nested Schema : extension
Type: object
The extended attributes.
Nested Schema : Notes
Type: object
Show Source
Nested Schema : comments
Type: array
The list of comments associated with the note.
Show Source
Nested Schema : extension
Type: object
The extended attributes.
Nested Schema : Comments
Type: object
The list of comments associated with the note.
Show Source
Back to Top

Response

200 Response

The bill unit was successfully removed from collections.

500 Response

An internal server error occurred.
Back to Top

Examples

This example shows how to remove a bill unit from collections 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/exit/0.0.0.1+-billinfo+128084' -H 'content-type: application/json' -d @exitCollections.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.
  • exitCollections.json is the JSON file that specifies the exit details.

Example of Request Body

This example shows the contents of the exitCollections.json file sent as the request body. Because a note ID is specified, the comment is added to an existing note. 

{
   "notes": {
      "billUnitId": "0.0.0.1+-billinfo+128084",
      "accountId": "0.0.0.1+-account+130964",
      "domainId": 0,
      "reasonId": 0,
      "type": 900,
      "subType": 901,
      "status": 101,
      "effectiveDate": "2021-02-08",
      "id": "0.0.0.1+-note+278620",
      "comments": [
         {
            "comment": "Exiting collections on request."
         }
      ]
   }
}

Example of Response Body

If successful, the response code 200 is returned with true in the response body.

Back to Top