Get Refundable Items for an Account
get
/bcws/webresources/v1.0/refunds/items/account/{id}
Gets refundable items for an account, such as unallocated adjustments, unallocated payments, and refundable bills.
Request
Path Parameters
-
id(required): string
The account ID for the refundable items.
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/xml
- application/json
200 Response
The list of refundable items was returned successfully.
Nested Schema : refundableItems
Type:
Show Source
object
-
amount: number
The amount of the refund.
-
arActionId: string
The ID of the A/R action associated with the refundable item.
-
billRef: object
ResourceRef
-
billUnitName: string
The name of the bill unit associated with the refundable item.
-
extension: object
extension
The extended attributes.
-
type: string
The refundable items's type.
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.
500 Response
An internal server error occurred.
Examples
This example shows how to get the refundable items for an account by submitting a GET request on the REST resource using cURL. For more information about cURL, see "Use cURL".
cURL Command
curl -X GET 'http://hostname:port/bcws/webresources/version/refunds/items/account/0.0.0.1+-account+123217'
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.
Example of Response Body
This example shows the contents of the response body in JSON format.
[
{
"extension": null,
"billUnitName": "Bill Unit(1)",
"type": "/item/payment",
"arActionId": "P1-66",
"billRef": null,
"amount": -200
},
{
"extension": null,
"billUnitName": "Bill Unit(1)",
"type": "/item/payment",
"arActionId": "P1-48",
"billRef": null,
"amount": -2
},
{
"extension": null,
"billUnitName": "Bill Unit(1)",
"type": "/item/payment",
"arActionId": "P1-49",
"billRef": null,
"amount": -25
},
{
"extension": null,
"billUnitName": "Bill Unit(1)",
"type": "/item/payment",
"arActionId": "P1-50",
"billRef": null,
"amount": -25
}
]