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

Refund Part of a Bill

post

/bcws/webresources/v1.0/refunds/bill/{id}/partialRefund

Creates a partial refund for the bill that matches the specified ID.

Request

Path Parameters
Supported Media Types
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 : Discriminator: @class
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
Nested Schema : ResourceRef
Type: object
Show Source
Nested Schema : extension
Type: object
The extended attributes.
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 : Discriminator: @class
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
Nested Schema : ResourceRef
Type: object
Show Source
Nested Schema : extension
Type: object
The extended attributes.
Back to Top

Response

Supported Media Types

201 Response

The partial refund was created successfully.
Body ()
Root Schema : resource
Type: object
Show Source
Nested Schema : extension
Type: object
The extended attributes.
Nested Schema : ResourceRef
Type: object
Show Source

400 Response

The request isn't valid.

500 Response

An internal server error occurred.
Back to Top

Examples

This example shows how to refund part of a bill 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/refunds/bill/0.0.0.1+-bill+80817/partialRefund' -H 'content-type: application/json' -d @partiallyRefundBill.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.
  • partiallyRefundBill.json is the JSON file that specifies the details of the refund.

Example of Request Body

This example shows the contents of the partiallyRefundBill.json file sent as the request body. 

{
    "amount": 2.02,
    "notes": {
        "amount": 2.02,
        "domainId": 6,
        "accountId": "0.0.0.1+-account+81329",
        "billUnitId": "0.0.0.1+-billinfo+78769",
        "reasonId": "2",
        "status": 101,
        "comments": [
            {
                "comment": "Refunding overcharge."
            }
        ]
    },
    "payinfoTypeObject": {
        "cashInfo": [
            {
                "effectiveDate": "2021-02-01T14:10:08.000Z",
                "receiptNo": "6891452"
             }
        ],
        "@class": "com.oracle.communications.brm.cc.model.Externalpayment10011",
        "accountObj": {
            "id": "0.0.0.1+-account+81329"
        },
        "paymentType": "10011",
        "externalType": true,
        "id": {
            "id": "0.0.0.1+-payinfo+986341"
        }
    }
}

Example of Response Body

This example shows the contents of the response body in JSON format.

{
    "extension": null,
    "reference": { 
        "id": "0.0.0.1+-item-refund+259386",
        "uri": "http://hostname:port/bcws/webresources/v1.0/refunds/0.0.0.1+-item-refund+259386"
    }
}
Back to Top