REST API Reference for Billing Care

Get Adjustments for a Bill Unit

get

/bcws/webresources/v1.0/adjustments/billunit/{id}

Gets all adjustments for the specified bill unit that match the query criteria.

Request

Path Parameters

id(required): string

The ID of the bill unit.

Query Parameters

type: string
The type of adjustments to retrieve. The type can be:
- unallocated: Gets only unallocated adjustments.
- allocated: Gets only allocated adjustments.
- all: Gets all adjustments. This is the default.

There's no request body for this operation.

Response

200 Response

The list of adjustments was returned successfully.

500 Response

An internal server error occurred.

Examples

This example shows how to get all adjustments that have been allocated for a specified bill unit 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/adjustments/billunit/0.0.0.1+-billinfo+60687?type=allocated'

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,
        "accountNumber": "0.0.0.1-57615",
        "firstName": "Mary",
        "lastName": "Williams",
        "effectiveDate": 1589447128000,
        "createdDate": null,
        "arActionType": null,
        "arActionAmount": -1,
        "arUnallocatedAmount": 0,
        "arActionId": "A1-1",
        "arActionRef": {
            "id": "0.0.0.1+-item-adjustment+76586",
            "uri": null
        },
        "billUnitName": null,
        "billID": null,
        "itemName": null,
        "billingStatus": null
    },
    {
        "extension": null,
        "accountNumber": null,
        "firstName": null,
        "lastName": null,
        "effectiveDate": 1589452345000,
        "createdDate": null,
        "arActionType": null,
        "arActionAmount": -1,
        "arUnallocatedAmount": 0,
        "arActionId": "A1-4",
        "arActionRef": {
            "id": "0.0.0.1+-item-adjustment+73707",
            "uri": null
        },
        "billUnitName": null,
        "billID": null,
        "itemName": null,
        "billingStatus": null
    },
]