1. REST Services Manager API for Billing and Revenue Management
  2. Tasks
  3. Prepay Balance Management
  4. Adjusted Balances

Create an Adjusted Balance

post

/adjustBalance

Creates an adjusted balance.

Request

There are no request parameters for this operation.

Supported Media Types
Request Body - application/json;charset=utf-8 ()
Root Schema : Adjust Balance Create
Type: object
Title: Adjust Balance Create
An adjustment to a balance, used in AdjustBalance create requests. The id, href, status, requestedDate, confirmationDate, relatedParty, and partyAccount properties are not used in create requests.

The value for amount can be a positive or negative integer. For bill and item adjustments, a positive amount indicates a debit adjustment to increase the amount due and a negative amount indicates a credit adjustment to decrease the amount due. For event adjustments, the opposite is true: a positive amount indicates a credit adjustment to decrease the amount due and a negative amount indicates a debit adjustment to increase the amount due.

For non-currency adjustments, the bucket property is required.

Show Source
Nested Schema : Quantity
Type: object
An amount in a given unit.
Show Source
Nested Schema : Bucket Ref
Type: object
Title: Bucket Ref
A reference to a bucket.
Show Source
Nested Schema : Channel Ref
Type: object
Title: Channel Ref
A reference to a channel.
Show Source
Nested Schema : logicalResource
Type: array
Logical resources associated with the adjusted balance.
Show Source
Nested Schema : product
Type: array
Products associated with the adjusted balance.
Show Source
Nested Schema : Related Party
Type: object
Title: Related Party
A party related to another object.
Show Source
Nested Schema : TimePeriod
Type: object
A period of time.
Show Source
Nested Schema : Logical Resource Ref
Type: object
Title: Logical Resource Ref
A reference to a logical resource.
Show Source
Nested Schema : Product Ref
Type: object
Title: Product Ref
A reference to a product.
Show Source
Back to Top

Response

Supported Media Types

201 Response

Created
Body ()
Root Schema : Adjust Balance
Type: object
Title: Adjust Balance
An adjustment to a balance.
Show Source
Nested Schema : Quantity
Type: object
An amount in a given unit.
Show Source
Nested Schema : Bucket Ref
Type: object
Title: Bucket Ref
A reference to a bucket.
Show Source
Nested Schema : Channel Ref
Type: object
Title: Channel Ref
A reference to a channel.
Show Source
Nested Schema : logicalResource
Type: array
Logical resources associated with the adjusted balance.
Show Source
Nested Schema : Party Account Ref
Type: object
Title: Party Account Ref
A reference to a party account.
Show Source
Nested Schema : product
Type: array
Products associated with the adjusted balance.
Show Source
Nested Schema : relatedParty
Type: array
Parties related to the adjusted balance.
Show Source
Nested Schema : Related Party
Type: object
Title: Related Party
A party related to another object.
Show Source
Nested Schema : TimePeriod
Type: object
A period of time.
Show Source
Nested Schema : Logical Resource Ref
Type: object
Title: Logical Resource Ref
A reference to a logical resource.
Show Source
Nested Schema : Product Ref
Type: object
Title: Product Ref
A reference to a product.
Show Source

400 Response

Bad Request
Body ()
Root Schema : Error
Type: object
This is used when an API throws an error, typically with a HTTP error response-code (3xx, 4xx, 5xx).
Show Source

401 Response

Unauthorized
Body ()
Root Schema : Error
Type: object
This is used when an API throws an error, typically with a HTTP error response-code (3xx, 4xx, 5xx).
Show Source

403 Response

Forbidden
Body ()
Root Schema : Error
Type: object
This is used when an API throws an error, typically with a HTTP error response-code (3xx, 4xx, 5xx).
Show Source

405 Response

Method Not allowed
Body ()
Root Schema : Error
Type: object
This is used when an API throws an error, typically with a HTTP error response-code (3xx, 4xx, 5xx).
Show Source

409 Response

Conflict
Body ()
Root Schema : Error
Type: object
This is used when an API throws an error, typically with a HTTP error response-code (3xx, 4xx, 5xx).
Show Source

500 Response

Internal Server Error
Body ()
Root Schema : Error
Type: object
This is used when an API throws an error, typically with a HTTP error response-code (3xx, 4xx, 5xx).
Show Source
Back to Top

Examples

The following example shows how to create a balance adjustment by submitting a POST request on the REST resource using cURL. For more information about cURL, see Use cURL.

The -d option specifies the file to attach as the request body.

curl -X POST 'http://host:port/brm/prepayBalanceManagement/version/adjustBalance' -d @adjustBalanceCreate.json

Example of Request Body

The following is an example of the contents of the adjustBalanceCreate.json file sent as the request body. 

{
 "description": "Non-currency Adjustment",
 "reason": "1",
 "bucket": {
    "id": "0.0.0.1+-balance_group+71659"
 },
 "amount": {
     "amount": "5",
     "units": "Free Minutes"
 },
 "validFor": {
     "startDateTime": "2020-05-21T13:14:53+05:30",
     "endDateTime":"2020-05-21T13:14:53+05:30"
 }
}

Example of Response Body

The following is an example of the response body in JSON format.

{
    "id": "0.0.0.1+-adjustment+227008",
    "href": "http://host:port/brm/prepayBalanceManagement/version/adjustBalance/0.0.0.1+-adjustment+227008",
    "confirmationDate": "2020-01-08T07:40:45-08:00",
    "description": "Non-currency Adjustment",
    "reason": "1",
    "requestedDate": "2020-01-08T07:40:45-08:00",
    "adjustType": null,
    "amount": {
        "amount": -5.0,
        "units": "Free Minutes",
        "@baseType": null,
        "@schemaLocation": null,
        "@type": null
    },
    "bucket": {
	"id": "0.0.0.1+-balance_group+71659"
	"href": "http://host:port/brm/prepayBalanceManagement/version/bucket/0.0.0.1+-balance_group+71659"
	},
    "channel": null,
    "logicalResource": null,
    "partyAccount": {
        "id": "0.0.0.1+-account+228862",
        "href": null,
        "description": null,
        "name": "Danielle Rao",
        "status": null,
        "@baseType": null,
        "@schemaLocation": null,
        "@type": null,
        "@referredType": null
    },
    "product": null,
    "relatedParty": null,
    "requestor": {
        "id": null,
        "href": null,
        "name": "Billing Care",
        "role": null,
        "@baseType": null,
        "@schemaLocation": null,
        "@type": null,
        "@referredType": null
    },
    "status": "COMPLETED",
    "usageType": "OTHER",
    "validFor": {
	"startDateTime": "2020-05-21T13:14:53+05:30",
     "endDateTime":"2020-05-21T13:14:53+05:30"
	 },
    "@baseType": "AdjustBalance",
    "@schemaLocation": null,
    "@type": "AdjustBalance"
}
Back to Top