Jump to

• Request
• Response
• Examples

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 Top

Response

Supported Media Types

• application/xml
• application/json

200 Response

The bill units were returned successfully.

Body ()

Root Schema : accountSummary

Type: object

Show Source

• 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.
• id: object ResourceRef
• 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.

{
    "required":[
        "billInProgressDue",
        "disputed",
        "dueNow",
        "numBills",
        "paymentTypeId",
        "pendingDue",
        "pendingDueDate",
        "unallocatedAdjustments",
        "unallocatedPayments"
    ],
    "type":"object",
    "properties":{
        "extension":{
            "type":"object",
            "description":"The extended attributes."
        },
        "pendingDue":{
            "type":"number",
            "description":"The amount for the bill unit that is in pending state."
        },
        "pendingDueDate":{
            "type":"string",
            "description":"The date and time the pending amount is due.",
            "format":"date-time"
        },
        "unallocatedPayments":{
            "type":"number",
            "description":"The payment amount that is still unallocated."
        },
        "unallocatedAdjustments":{
            "type":"number",
            "description":"The adjustment amount that is still unallocated."
        },
        "billInProgressDue":{
            "type":"number",
            "description":"The in progress amount due for the bill unit."
        },
        "dueNow":{
            "type":"number",
            "description":"The amount that is due now."
        },
        "numBills":{
            "type":"integer",
            "description":"The number of bills associated with the bill unit."
        },
        "disputed":{
            "type":"number",
            "description":"The amount for the bill unit that is in dispute."
        },
        "paymentTypeId":{
            "type":"string",
            "description":"The ID for the bill unit's payment type."
        },
        "id":{
            "$ref":"#/components/schemas/ResourceRef"
        }
    },
    "xml":{
        "name":"accountSummary"
    }
}

Nested Schema : extension

Type: object

The extended attributes.

Nested Schema : ResourceRef

Type: object

Show Source

• id(required): string
  The ID.
• uri: string
  The Uniform Resource Identifier (URI) associated with the resource.

{
    "required":[
        "id"
    ],
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"The ID."
        },
        "uri":{
            "type":"string",
            "description":"The Uniform Resource Identifier (URI) associated with the resource."
        }
    }
}

500 Response

An internal server error occurred.

Back to Top

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
}

Back to Top