Get a Bill Unit Summary for an Account
get
/bcws/webresources/v1.0/billunits/account/{id}/summary
Gets a consolidated summary of all bill units for the specified account.
Request
Path Parameters
-
id(required): string
The ID for the account.
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/xml
- application/json
200 Response
The bill units were returned successfully.
Root Schema : accountSummary
Type:
Show Source
object
-
billInProgressDue(required): number
The in progress amount due for the bill unit.
-
disputed(required): number
The amount for the bill unit that is in dispute.
-
dueNow(required): number
The amount that is due now.
-
extension: object
extension
The extended attributes.
-
numBills(required): integer
The number of bills associated with the bill unit.
-
paymentTypeId(required): string
The ID for the bill unit's payment type.
-
pendingDue(required): number
The amount for the bill unit that is in pending state.
-
pendingDueDate(required): string
(date-time)
The date and time the pending amount is due.
-
unallocatedAdjustments(required): number
The adjustment amount that is still unallocated.
-
unallocatedPayments(required): number
The payment amount that is still unallocated.
Nested Schema : extension
Type:
object
The extended attributes.
500 Response
An internal server error occurred.
Examples
This example shows how to get a consolidated summary of all bill units for the specified 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/billunits/account/0.0.0.1+-account+57615/summary'
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,
"pendingDue": 49.95,
"pendingDueDate": null,
"unallocatedPayments": -10.55,
"unallocatedAdjustments": null,
"billInProgressDue": null,
"dueNow": 231.71,
"numBills": null,
"disputed": 0,
"paymentTypeId": null
}