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

Create an Event Adjustment

post

/bcws/webresources/v1.0/adjustments/event

Creates an event-level adjustment for the account specified in the payload's contents.

Request

There are no request parameters for this operation.

Supported Media Types
Request Body - application/xml ()
Information about the event-level adjustment. The minimum required parameters are:
  • accountRef
    • id
  • amount
  • events
    • eventRef
      • id
Root Schema : schema
Type: object
Show Source
Nested Schema : ResourceRef
Type: object
Show Source
Nested Schema : billItem
Type: array
The bill item details.
Show Source
Nested Schema : Events
Type: object
The events.
Show Source
Nested Schema : extension
Type: object
The extended attributes.
Nested Schema : Notes
Type: object
Show Source
Nested Schema : billItem
Type: object
The bill item details.
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
Nested Schema : eventRef
Type: array
Show Source
Nested Schema : comments
Type: array
The list of comments associated with the note.
Show Source
Nested Schema : extension
Type: object
The extended attributes.
Nested Schema : Comments
Type: object
The list of comments associated with the note.
Show Source
Request Body - application/json ()
Information about the event-level adjustment. The minimum required parameters are:
  • accountRef
    • id
  • amount
  • events
    • eventRef
      • id
Root Schema : schema
Type: object
Show Source
Nested Schema : ResourceRef
Type: object
Show Source
Nested Schema : billItem
Type: array
The bill item details.
Show Source
Nested Schema : Events
Type: object
The events.
Show Source
Nested Schema : extension
Type: object
The extended attributes.
Nested Schema : Notes
Type: object
Show Source
Nested Schema : billItem
Type: object
The bill item details.
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
Nested Schema : eventRef
Type: array
Show Source
Nested Schema : comments
Type: array
The list of comments associated with the note.
Show Source
Nested Schema : extension
Type: object
The extended attributes.
Nested Schema : Comments
Type: object
The list of comments associated with the note.
Show Source
Back to Top

Response

Supported Media Types

201 Response

The event adjustment was created successfully.
Body ()
Root Schema : schema
Type: object
Show Source
Nested Schema : ResourceRef
Type: object
Show Source
Nested Schema : billItem
Type: array
The bill item details.
Show Source
Nested Schema : Events
Type: object
The events.
Show Source
Nested Schema : extension
Type: object
The extended attributes.
Nested Schema : Notes
Type: object
Show Source
Nested Schema : billItem
Type: object
The bill item details.
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
Nested Schema : eventRef
Type: array
Show Source
Nested Schema : comments
Type: array
The list of comments associated with the note.
Show Source
Nested Schema : extension
Type: object
The extended attributes.
Nested Schema : Comments
Type: object
The list of comments associated with the note.
Show Source

400 Response

The request isn't valid.

500 Response

An internal server error occurred.
Back to Top

Examples

This example shows how to create an event adjustment 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/adjustments/event' -H 'content-type: application/json' -d @adjust.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.
  • adjust.json is the JSON file that specifies the adjustment to make.

Example of Request Body

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

{
    "amount": -1,
    "percent": -10.05,
    "notes": {
        "amount": 1,
        "domainId": 38,
        "accountId": "0.0.0.1+-account+81329",
        "billUnitId": "0.0.0.1+-billinfo+78769",
        "reasonId": "1",
        "status": 101,
        "comments": [
            {
                "comment": ""
            }
        ]
    },
    "accountRef": 
        {
            "id": "0.0.0.1+-account+81329"
        },
    "taxType": 8,
    "resourceId": 840,
    "events": {
        "eventRef": [
            {
                "id": "0.0.0.1 /event/billing/product/fee/cycle/cycle_forward_monthly 326194313635733176 0"
            }
        ]
    }
}

Example of Response Body

This example shows the contents of the response body in JSON format.

{
    "extension": null,
    "actionAffectsRef": null,
    "effective": null,
    "notes": {
        "extension": null,
        "id": "0.0.0.1+-note+277149",
        "accountId": "0.0.0.1+-account+81329",
        "amount": 1,
        "billUnitId": "0.0.0.1+-billinfo+78769",
        "billId": null,
        "closedDate": null,
        "count": null,
        "effectiveDate": null,
        "eventId": null,
        "header": null,
        "itemId": "0.0.0.1+-item-adjustment+276637",
        "subType": 204,
        "type": 200,
        "domainId": 38,
        "reasonId": 1,
        "serviceId": null,
        "status": 101,
        "comments": [
            {
                "csrLoginId": null,
                "csrFirstName": null,
                "csrLastName": null,
                "csrAccountId": null,
                "externalUser": "Test Client",
                "comment": "",
                "trackingId": null,
                "entryDate": null
            }
        ]
    },
    "amount": -1,
    "amountIsCredit": null,
    "resourceId": 840,
    "includeTax": null,
    "percent": -10.05,
    "billItem": [],
    "appliesToTotalOfAllEvents": false,
    "taxType": 8,
    "accountRef": {
        "id": "0.0.0.1+-account+81329",
        "uri": null
    },
    "events": {
        "eventRef": [
            {
                "id": "0.0.0.1 /event/billing/product/fee/cycle/cycle_forward_monthly 326194313635733176 0",
                "uri": null
            }
        ]
    }
}
Back to Top