1. REST API Reference for Billing Care
  2. Tasks
  3. Allocations

Allocate a Payment to Bill Items

post

/bcws/webresources/v1.0/allocations/payment/{id}/items

Allocates a payment to one or more bill items.

Request

Path Parameters
Supported Media Types
Request Body - application/json ()
A list of bill items containing an allocated amount, the account ID, and the bill item ID. The minimum required parameters are:
  • amount
  • id
Root Schema : schema
Type: array
Show Source
Nested Schema : billItem
Type: object
The bill item details.
Show Source
Nested Schema : ResourceRef
Type: object
Show Source
Nested Schema : aliasList
Type: array
The list of aliases in the bill item.
Show Source
Nested Schema : extension
Type: object
The extended attributes.
Nested Schema : AliasList
Type: object
The list of aliases associated with the service.
Show Source
Request Body - application/xml ()
A list of bill items containing an allocated amount, the account ID, and the bill item ID. The minimum required parameters are:
  • amount
  • id
Root Schema : schema
Type: array
Show Source
Nested Schema : billItem
Type: object
The bill item details.
Show Source
Nested Schema : ResourceRef
Type: object
Show Source
Nested Schema : aliasList
Type: array
The list of aliases in the bill item.
Show Source
Nested Schema : extension
Type: object
The extended attributes.
Nested Schema : AliasList
Type: object
The list of aliases associated with the service.
Show Source
Back to Top

Response

201 Response

The payment was allocated successfully.

500 Response

An internal server error occurred.
Back to Top

Examples

This example shows how to allocate a payment to bill items by submitting a POST request on the REST resource using cURL. For more information about cURL, see "Use cURL".

cURL Command

curl -X POST 'http://hostname:port/bcws/webresources/v1.0/allocations/payment/0.0.0.1+-item-payment+128048/items' -H 'content-type: application/json' -d @allocateToItems.json

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.
  • allocateToItems.json is the JSON file that specifies the payment allocation to make.

Example of Request Body

This example shows the contents of the allocateToItems.json file sent as the request body. 

[
  {
    "extension": null,
    "id": "0.0.0.1+-item-cycle_forward+169656",
    "name": "Cycle forward",
    "type": "/item/cycle_forward",
    "accountRef": {
      "id": "0.0.0.1+-account+81329",
      "uri": null
    },
    "arBillinfoRef": null,
    "arBillRef": {
      "id": "0.0.0.1+-bill+143952",
      "uri": null
    },
    "billRef": {
      "id": "0.0.0.1+-bill+143952",
      "uri": null
    },
    "serviceRef": {
      "id": "0.0.0.1+-service-ip+78705",
      "uri": null
    },
    "billinfoRef": null,
    "creationDate": null,
    "closedDate": null,
    "currency": null,
    "deltaDue": null,
    "disputed": 0,
    "adjusted": -0.25,
    "due": 9.7,
    "itemNo": "B1-591,3",
    "login": "34",
    "received": 0,
    "transfered": 0,
    "writeoff": 0,
    "amount": 1,
    "discount": null,
    "billNo": "B1-591",
    "billInfoId": "Bill Unit(1)",
    "firstName": "Marie",
    "lastName": "Fortin",
    "serviceTypeName": "ip",
    "accountNumber": "0.0.0.1-81329",
    "aliasList": [],
    "status": null
  }
]

Example of Response Body

If successful, the response code 204 is returned with no response body.

Back to Top