REST API Reference for Billing Care

Get All Adjustments for an Account

get

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

Gets the list of adjustments for the specified account ID.

Request

Path Parameters

id(required): string

The ID of the account.

Query Parameters

type(required): 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

Supported Media Types

application/xml
application/json

200 Response

The list of adjustments was returned successfully.

Root Schema : schema

Type: array

Show Source

Array of: object arActionsList

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/ArActionsList"
    }
}

Nested Schema : arActionsList

Type: object

Show Source

accountNumber: string

The account number.
arActionAmount(required): number

The amount associated with the A/R action.
arActionId: string

The ID of the A/R action.
arActionRef: object ResourceRef
arActionType: integer (int32)

The type of A/R action: item adjustment (0), event adjustment (1), bill adjustment (2), account adjustment (3), refund (4), open item dispute (6), settled item dispute (7), item payment (8), open event dispute (9), settled event dispute (10), open bill dispute (11), settled bill dispute (12), account writeoff (13), bill writeoff (14), or item writeoff (15).
arUnallocatedAmount: number

The amount that is still unallocated.
billID: string

The ID of the bill.
billingStatus: integer (int32)

The billing status: billed (1) or unbilled (2).
billUnitName: string

The name of the bill unit.
createdDate: string (date-time)

The date and time the A/R action was created.
effectiveDate: string (date-time)

The date and time the A/R action takes effect.
extension: object extension

The extended attributes.
firstName: string

The customer's first name.
itemName: string

The item name.
lastName: string

The customer's last name.

{
    "required":[
        "arActionAmount"
    ],
    "type":"object",
    "properties":{
        "extension":{
            "type":"object",
            "description":"The extended attributes."
        },
        "accountNumber":{
            "type":"string",
            "description":"The account number."
        },
        "firstName":{
            "type":"string",
            "description":"The customer's first name."
        },
        "lastName":{
            "type":"string",
            "description":"The customer's last name."
        },
        "effectiveDate":{
            "type":"string",
            "description":"The date and time the A/R action takes effect.",
            "format":"date-time"
        },
        "createdDate":{
            "type":"string",
            "description":"The date and time the A/R action was created.",
            "format":"date-time"
        },
        "arActionType":{
            "type":"integer",
            "description":"The type of A/R action: item adjustment (<b>0</b>), event adjustment (<b>1</b>), bill adjustment (<b>2</b>), account adjustment (<b>3</b>), refund (<b>4</b>), open item dispute (<b>6</b>), settled item dispute (<b>7</b>), item payment (<b>8</b>), open event dispute (<b>9</b>), settled event dispute (<b>10</b>), open bill dispute (<b>11</b>), settled bill dispute (<b>12</b>), account writeoff (<b>13</b>), bill writeoff (<b>14</b>), or item writeoff (<b>15</b>).",
            "format":"int32"
        },
        "arActionAmount":{
            "type":"number",
            "description":"The amount associated with the A/R action."
        },
        "arUnallocatedAmount":{
            "type":"number",
            "description":"The amount that is still unallocated."
        },
        "arActionId":{
            "type":"string",
            "description":"The ID of the A/R action."
        },
        "arActionRef":{
            "$ref":"#/components/schemas/ResourceRef"
        },
        "billUnitName":{
            "type":"string",
            "description":"The name of the bill unit."
        },
        "billID":{
            "type":"string",
            "description":"The ID of the bill."
        },
        "itemName":{
            "type":"string",
            "description":"The item name."
        },
        "billingStatus":{
            "type":"integer",
            "description":"The billing status: billed (<b>1</b>) or unbilled (<b>2</b>).",
            "format":"int32"
        }
    },
    "xml":{
        "name":"arActionsList"
    }
}

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."
        }
    }
}

Nested Schema : extension

Type: object

The extended attributes.

500 Response

An internal server error occurred.

Examples

This example shows how to get all adjustments that have been allocated for a 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/v1.0/adjustments/account/0.0.0.1+-account+81329?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": null,
        "firstName": null,
        "lastName": null,
        "effectiveDate": 1585787580000,
        "createdDate": null,
        "arActionType": null,
        "arActionAmount": -1,
        "arUnallocatedAmount": 0,
        "arActionId": "A1-10",
        "arActionRef": {
            "id": "0.0.0.1+-item-adjustment+124613",
            "uri": null
        },
        "billUnitName": null,
        "billID": null,
        "itemName": null,
        "billingStatus": null
    },
    {
        "extension": null,
        "accountNumber": null,
        "firstName": null,
        "lastName": null,
        "effectiveDate": 1605164364000,
        "createdDate": null,
        "arActionType": null,
        "arActionAmount": -100,
        "arUnallocatedAmount": 0,
        "arActionId": "A1-155",
        "arActionRef": {
            "id": "0.0.0.1+-item-adjustment+200873",
            "uri": null
        },
        "billUnitName": null,
        "billID": null,
        "itemName": null,
        "billingStatus": null
    },
    {
        "extension": null,
        "accountNumber": null,
        "firstName": null,
        "lastName": null,
        "effectiveDate": 1605264957000,
        "createdDate": null,
        "arActionType": null,
        "arActionAmount": -100,
        "arUnallocatedAmount": 0,
        "arActionId": "A1-157",
        "arActionRef": {
            "id": "0.0.0.1+-item-adjustment+202985",
            "uri": null
        },
        "billUnitName": null,
        "billID": null,
        "itemName": null,
        "billingStatus": null
    },
    {
        "extension": null,
        "accountNumber": null,
        "firstName": null,
        "lastName": null,
        "effectiveDate": 1611831546000,
        "createdDate": null,
        "arActionType": null,
        "arActionAmount": 1,
        "arUnallocatedAmount": 0,
        "arActionId": "A1-160",
        "arActionRef": {
            "id": "0.0.0.1+-item-adjustment+265424",
            "uri": null
        },
        "billUnitName": null,
        "billID": null,
        "itemName": null,
        "billingStatus": null
    },
    {
        "extension": null,
        "accountNumber": null,
        "firstName": null,
        "lastName": null,
        "effectiveDate": 1611832859000,
        "createdDate": null,
        "arActionType": null,
        "arActionAmount": 1,
        "arUnallocatedAmount": 0,
        "arActionId": "A1-162",
        "arActionRef": {
            "id": "0.0.0.1+-item-adjustment+261962",
            "uri": null
        },
        "billUnitName": null,
        "billID": null,
        "itemName": null,
        "billingStatus": null
    },
    {
        "extension": null,
        "accountNumber": null,
        "firstName": null,
        "lastName": null,
        "effectiveDate": 1611835908000,
        "createdDate": null,
        "arActionType": null,
        "arActionAmount": -0.34,
        "arUnallocatedAmount": 0,
        "arActionId": "A1-164",
        "arActionRef": {
            "id": "0.0.0.1+-item-adjustment+257258",
            "uri": null
        },
        "billUnitName": null,
        "billID": null,
        "itemName": null,
        "billingStatus": null
    },
    {
        "extension": null,
        "accountNumber": null,
        "firstName": null,
        "lastName": null,
        "effectiveDate": 1611837659000,
        "createdDate": null,
        "arActionType": null,
        "arActionAmount": 1,
        "arUnallocatedAmount": 0,
        "arActionId": "A1-167",
        "arActionRef": {
            "id": "0.0.0.1+-item-adjustment+259059",
            "uri": null
        },
        "billUnitName": null,
        "billID": null,
        "itemName": null,
        "billingStatus": null
    },
    {
        "extension": null,
        "accountNumber": null,
        "firstName": null,
        "lastName": null,
        "effectiveDate": 1611838169000,
        "createdDate": null,
        "arActionType": null,
        "arActionAmount": -1,
        "arUnallocatedAmount": 0,
        "arActionId": "A1-168",
        "arActionRef": {
            "id": "0.0.0.1+-item-adjustment+263730",
            "uri": null
        },
        "billUnitName": null,
        "billID": null,
        "itemName": null,
        "billingStatus": null
    },
    {
        "extension": null,
        "accountNumber": null,
        "firstName": null,
        "lastName": null,
        "effectiveDate": 1611903898000,
        "createdDate": null,
        "arActionType": null,
        "arActionAmount": -0.75,
        "arUnallocatedAmount": 0,
        "arActionId": "A1-169",
        "arActionRef": {
            "id": "0.0.0.1+-item-adjustment+261578",
            "uri": null
        },
        "billUnitName": null,
        "billID": null,
        "itemName": null,
        "billingStatus": null
    },
    {
        "extension": null,
        "accountNumber": null,
        "firstName": null,
        "lastName": null,
        "effectiveDate": 1611907545000,
        "createdDate": null,
        "arActionType": null,
        "arActionAmount": 3,
        "arUnallocatedAmount": 0,
        "arActionId": "A1-170",
        "arActionRef": {
            "id": "0.0.0.1+-item-adjustment+255819",
            "uri": null
        },
        "billUnitName": null,
        "billID": null,
        "itemName": null,
        "billingStatus": null
    },
    {
        "extension": null,
        "accountNumber": null,
        "firstName": null,
        "lastName": null,
        "effectiveDate": 1611958639000,
        "createdDate": null,
        "arActionType": null,
        "arActionAmount": 1,
        "arUnallocatedAmount": 0,
        "arActionId": "A1-172",
        "arActionRef": {
            "id": "0.0.0.1+-item-adjustment+257082",
            "uri": null
        },
        "billUnitName": null,
        "billID": null,
        "itemName": null,
        "billingStatus": null
    },
    {
        "extension": null,
        "accountNumber": null,
        "firstName": null,
        "lastName": null,
        "effectiveDate": 1612208317000,
        "createdDate": null,
        "arActionType": null,
        "arActionAmount": 1,
        "arUnallocatedAmount": 0,
        "arActionId": "A1-199",
        "arActionRef": {
            "id": "0.0.0.1+-item-adjustment+256731",
            "uri": null
        },
        "billUnitName": null,
        "billID": null,
        "itemName": null,
        "billingStatus": null
    },
    {
        "extension": null,
        "accountNumber": null,
        "firstName": null,
        "lastName": null,
        "effectiveDate": 1612553674000,
        "createdDate": null,
        "arActionType": null,
        "arActionAmount": 1,
        "arUnallocatedAmount": 0,
        "arActionId": "A1-205",
        "arActionRef": {
            "id": "0.0.0.1+-item-adjustment+272577",
            "uri": null
        },
        "billUnitName": null,
        "billID": null,
        "itemName": null,
        "billingStatus": null
    },
    {
        "extension": null,
        "accountNumber": null,
        "firstName": null,
        "lastName": null,
        "effectiveDate": 1612554011000,
        "createdDate": null,
        "arActionType": null,
        "arActionAmount": -0.75,
        "arUnallocatedAmount": 0,
        "arActionId": "A1-206",
        "arActionRef": {
            "id": "0.0.0.1+-item-adjustment+278045",
            "uri": null
        },
        "billUnitName": null,
        "billID": null,
        "itemName": null,
        "billingStatus": null
    },
    {
        "extension": null,
        "accountNumber": null,
        "firstName": null,
        "lastName": null,
        "effectiveDate": 1612566986000,
        "createdDate": null,
        "arActionType": null,
        "arActionAmount": 1,
        "arUnallocatedAmount": 0,
        "arActionId": "A1-207",
        "arActionRef": {
            "id": "0.0.0.1+-item-adjustment+276637",
            "uri": null
        },
        "billUnitName": null,
        "billID": null,
        "itemName": null,
        "billingStatus": null
    }
]