Jump to

• Request
• Response
• Examples

Get a Bill Item

get

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

Gets the bill items that match the specified query parameters.

Request

Path Parameters

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

Query Parameters

• count: integer(int32)
  The number of bill items to retrieve.
• expand: string
  Whether to retreive the bill items for the parent bill unit and its child bill units (all) or just the child bill units (childonly).
• type: string
  The type of bill items to retrieve: open or past. Open retrieves all bill items irrespective of the due date. Past retrieves only the bill items whose due date has passed.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/xml
• application/json

200 Response

The bill item was returned successfully.

Body ()

Root Schema : schema

Type: array

Show Source

• Array of: object billItem
  The bill item details.

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

Nested Schema : billItem

Type: object

The bill item details.

Show Source

• accountName: string
  The name of the account.
• accountNumber: string
  The account number associated with the bill item.
• accountRef: object ResourceRef
• adjusted: number
  The total amount from debit and credit adjustments made to the bill item.
• aliasList: array aliasList
  The list of aliases in the bill item.
• amount(required): number
  The amount of the bill item.
• arBillinfoRef: object ResourceRef
• arBillRef: object ResourceRef
• billInfoId: string
  The ID of the /billinfo object.
• billinfoRef: object ResourceRef
• billNo: string
  The bill number.
• billRef: object ResourceRef
• closedDate: string (date-time)
  The date and time the bill item was closed. If the bill item is reopened for an adjustment, this is reset until the bill item is closed again.
• creationDate: string (date-time)
  The date and time the bill item was created.
• currency: integer (int32)
  The currency for the bill item, copied from the currency of the associated account.
• deltaDue: number
  The delta amount due.
• discount: number
  The amount discounted for the bill item.
• disputed: number
  The total amount from disputes associated with the bill item.
• due: number
  The amount due for the bill item.
• dueDate: string (date-time)
  The date when the amount in the bill item is due.
• extension: object extension
  The extended attributes.
• firstName: string
  The first name of the account holder.
• id(required): string
  The ID.
• itemNo: string
  The bill item's number.
• lastName: string
  The last name of the account holder.
• login: string
  The username associated with the bill item.
• name: string
  The bill item's name.
• received: number
  The amount of payments or credits applied to the bill item.
• serviceRef: object ResourceRef
• serviceTypeName: string
  The name of the service type.
• status: string
  The status of the bill item: active (10100), inactive (10102), or closed (10103)
• transfered: number
  The amount transferred out of the bill item.
• transferInto: array transferInto
• transferOut: array transferOut
• type: string
  The bill item's type.
• writeoff: number
  The amount written off for the bill item.

{
    "required":[
        "amount",
        "id"
    ],
    "type":"object",
    "properties":{
        "extension":{
            "type":"object",
            "description":"The extended attributes."
        },
        "id":{
            "type":"string",
            "description":"The ID."
        },
        "name":{
            "type":"string",
            "description":"The bill item's name."
        },
        "type":{
            "type":"string",
            "description":"The bill item's type."
        },
        "accountRef":{
            "$ref":"#/components/schemas/ResourceRef"
        },
        "arBillinfoRef":{
            "$ref":"#/components/schemas/ResourceRef"
        },
        "arBillRef":{
            "$ref":"#/components/schemas/ResourceRef"
        },
        "billRef":{
            "$ref":"#/components/schemas/ResourceRef"
        },
        "serviceRef":{
            "$ref":"#/components/schemas/ResourceRef"
        },
        "billinfoRef":{
            "$ref":"#/components/schemas/ResourceRef"
        },
        "creationDate":{
            "type":"string",
            "description":"The date and time the bill item was created.",
            "format":"date-time"
        },
        "closedDate":{
            "type":"string",
            "description":"The date and time the bill item was closed. If the bill item is reopened for an adjustment, this is reset until the bill item is closed again.",
            "format":"date-time"
        },
        "currency":{
            "type":"integer",
            "description":"The currency for the bill item, copied from the currency of the associated account.",
            "format":"int32"
        },
        "deltaDue":{
            "type":"number",
            "description":"The delta amount due."
        },
        "disputed":{
            "type":"number",
            "description":"The total amount from disputes associated with the bill item."
        },
        "adjusted":{
            "type":"number",
            "description":"The total amount from debit and credit adjustments made to the bill item."
        },
        "due":{
            "type":"number",
            "description":"The amount due for the bill item."
        },
        "dueDate":{
            "type":"string",
            "description":"The date when the amount in the bill item is due.",
            "format":"date-time"
        },
        "itemNo":{
            "type":"string",
            "description":"The bill item's number."
        },
        "login":{
            "type":"string",
            "description":"The username associated with the bill item."
        },
        "received":{
            "type":"number",
            "description":"The amount of payments or credits applied to the bill item."
        },
        "transfered":{
            "type":"number",
            "description":"The amount transferred out of the bill item."
        },
        "writeoff":{
            "type":"number",
            "description":"The amount written off for the bill item."
        },
        "amount":{
            "type":"number",
            "description":"The amount of the bill item."
        },
        "discount":{
            "type":"number",
            "description":"The amount discounted for the bill item."
        },
        "billNo":{
            "type":"string",
            "description":"The bill number."
        },
        "billInfoId":{
            "type":"string",
            "description":"The ID of the /billinfo object."
        },
        "accountName":{
            "type":"string",
            "description":"The name of the account."
        },
        "firstName":{
            "type":"string",
            "description":"The first name of the account holder."
        },
        "lastName":{
            "type":"string",
            "description":"The last name of the account holder."
        },
        "serviceTypeName":{
            "type":"string",
            "description":"The name of the service type."
        },
        "accountNumber":{
            "type":"string",
            "description":"The account number associated with the bill item."
        },
        "aliasList":{
            "type":"array",
            "description":"The list of aliases in the bill item.",
            "items":{
                "$ref":"#/components/schemas/AliasList"
            }
        },
        "status":{
            "type":"string",
            "description":"The status of the bill item: active (<b>10100</b>), inactive (<b>10102</b>), or closed (<b>10103</b>)"
        },
        "transferInto":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/TransferInto"
            }
        },
        "transferOut":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/TransferOut"
            }
        }
    },
    "description":"The bill item details.",
    "xml":{
        "name":"billItem"
    }
}

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 : aliasList

Type: array

The list of aliases in the bill item.

Show Source

• Array of: object AliasList
  The list of aliases associated with the service.

{
    "type":"array",
    "description":"The list of aliases in the bill item.",
    "items":{
        "$ref":"#/components/schemas/AliasList"
    }
}

Nested Schema : extension

Type: object

The extended attributes.

Nested Schema : transferInto

Type: array

Show Source

• Array of: object TransferInto

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

Nested Schema : transferOut

Type: array

Show Source

• Array of: object TransferOut

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

Nested Schema : AliasList

Type: object

The list of aliases associated with the service.

Show Source

• elem: integer (int32)
• name: string

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string"
        },
        "elem":{
            "type":"integer",
            "format":"int32",
            "xml":{
                "attribute":true
            }
        }
    },
    "description":"The list of aliases associated with the service."
}

Nested Schema : TransferInto

Type: object

Show Source

• creationDate: string (date-time)
  The creation date for the bill item from which the balance was transferred.
• due: number
  The due date for the bill item from which the balance was transferred.
• itemNo: string
  The bill item number for the bill item from which the balance was transferred.
• itemRef: object ResourceRef
• name(required): string
  The name of the bill item from which the balance was transferred.
• transfered: number
  The amount transferred from the source bill item.

{
    "required":[
        "name"
    ],
    "type":"object",
    "properties":{
        "itemNo":{
            "type":"string",
            "description":"The bill item number for the bill item from which the balance was transferred."
        },
        "name":{
            "type":"string",
            "description":"The name of the bill item from which the balance was transferred."
        },
        "due":{
            "type":"number",
            "description":"The due date for the bill item from which the balance was transferred."
        },
        "creationDate":{
            "type":"string",
            "description":"The creation date for the bill item from which the balance was transferred.",
            "format":"date-time"
        },
        "itemRef":{
            "$ref":"#/components/schemas/ResourceRef"
        },
        "transfered":{
            "type":"number",
            "description":"The amount transferred from the source bill item."
        }
    }
}

Nested Schema : TransferOut

Type: object

Show Source

• creationDate: string (date-time)
  The creation date for the bill item to which the balance was transferred.
• due: number
  The due date for the bill item to which the balance was transferred.
• itemNo: string
  The bill item number for the bill item to which the balance was transferred.
• itemRef: object ResourceRef
• name(required): string
  The name of the bill item to which the balance was transferred.
• transfered: number
  The amount transferred to the target bill item.

{
    "required":[
        "name"
    ],
    "type":"object",
    "properties":{
        "itemNo":{
            "type":"string",
            "description":"The bill item number for the bill item to which the balance was transferred."
        },
        "name":{
            "type":"string",
            "description":"The name of the bill item to which the balance was transferred."
        },
        "due":{
            "type":"number",
            "description":"The due date for the bill item to which the balance was transferred."
        },
        "creationDate":{
            "type":"string",
            "description":"The creation date for the bill item to which the balance was transferred.",
            "format":"date-time"
        },
        "itemRef":{
            "$ref":"#/components/schemas/ResourceRef"
        },
        "transfered":{
            "type":"number",
            "description":"The amount transferred to the target bill item."
        }
    }
}

500 Response

An internal server error occurred.

Back to Top

Examples

This example shows how to get two of a bill unit's open bill items 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/items/billunit/0.0.0.1+-billinfo+60687?type=open&count=2'

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,
        "id": "0.0.0.1+-item-cycle_forward+256298",
        "name": "Cycle forward",
        "type": "/item/cycle_forward",
        "accountRef": {
            "id": "0.0.0.1+-account+57615",
            "uri": null
        },
        "arBillinfoRef": null,
        "arBillRef": {
            "id": "0.0.0.1+-bill+215753",
            "uri": null
        },
        "billRef": {
            "id": "0.0.0.1+-bill+215753",
            "uri": null
        },
        "serviceRef": {
            "id": "0.0.0.1+-service-ip+166570",
            "uri": null
        },
        "billinfoRef": null,
        "creationDate": null,
        "closedDate": null,
        "currency": null,
        "deltaDue": null,
        "disputed": 0,
        "adjusted": 0,
        "due": 29.95,
        "dueDate": 1612944000000,
        "itemNo": "B1-647,2",
        "login": "IP_Service",
        "received": 0,
        "transfered": 0,
        "writeoff": 0,
        "amount": null,
        "discount": null,
        "billNo": "B1-647",
        "billInfoId": "Bill Unit(1)",
        "accountName": null,
        "firstName": null,
        "lastName": null,
        "serviceTypeName": "ip",
        "accountNumber": "0.0.0.1-57615",
        "aliasList": [],
        "status": null
    },
    {
        "extension": null,
        "id": "0.0.0.1+-item-cycle_forward+257194",
        "name": "Cycle forward",
        "type": "/item/cycle_forward",
        "accountRef": {
            "id": "0.0.0.1+-account+57615",
            "uri": null
        },
        "arBillinfoRef": null,
        "arBillRef": {
            "id": "0.0.0.1+-bill+215753",
            "uri": null
        },
        "billRef": {
            "id": "0.0.0.1+-bill+215753",
            "uri": null
        },
        "serviceRef": {
            "id": "0.0.0.1+-service-ip+156801",
            "uri": null
        },
        "billinfoRef": null,
        "creationDate": null,
        "closedDate": null,
        "currency": null,
        "deltaDue": null,
        "disputed": 0,
        "adjusted": 0,
        "due": 10,
        "dueDate": 1612944000000,
        "itemNo": "B1-647,5",
        "login": "ip0",
        "received": 0,
        "transfered": 0,
        "writeoff": 0,
        "amount": null,
        "discount": null,
        "billNo": "B1-647",
        "billInfoId": "Bill Unit(1)",
        "accountName": null,
        "firstName": null,
        "lastName": null,
        "serviceTypeName": "ip",
        "accountNumber": "0.0.0.1-57615",
        "aliasList": [],
        "status": null
    }
]

Back to Top