Jump to

• Request
• Response
• Examples

Get A/R Actions for a Bill

get

/bcws/webresources/v1.0/bills/{id}/ar-actions

Gets the A/R actions for the specified bill ID.

Request

Path Parameters

• id(required): string
  The ID for the bill.

Query Parameters

• number(required): string
  The bill number, such as B1728.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/xml
• application/json

200 Response

The A/R actions were returned successfully.

Body ()

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

Back to Top

Examples

This example shows how to get the A/R actions for a specified bill 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/bills/0.0.0.1+-bill+200506/ar-actions'

• 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-81329",
        "firstName": "Nancy",
        "lastName": "Miller",
        "effectiveDate": 1605173177000,
        "createdDate": 1605173177000,
        "arActionType": 3,
        "arActionAmount": -1,
        "arUnallocatedAmount": null,
        "arActionId": "A1-156",
        "arActionRef": {
            "id": "0.0.0.1+-item-adjustment+208776",
            "uri": null
        },
        "billUnitName": null,
        "billID": null,
        "itemName": null,
        "billingStatus": null
    },
    {
        "extension": null,
        "accountNumber": "0.0.0.1-81329",
        "firstName": "Nancy",
        "lastName": "Miller",
        "effectiveDate": 1611836594000,
        "createdDate": 1611836594000,
        "arActionType": 3,
        "arActionAmount": -2.5,
        "arUnallocatedAmount": null,
        "arActionId": "A1-165",
        "arActionRef": {
            "id": "0.0.0.1+-item-adjustment+262194",
            "uri": null
        },
        "billUnitName": null,
        "billID": null,
        "itemName": null,
        "billingStatus": null
    }
]

Back to Top