Create an Adjusted Balance
/adjustBalance
Request
There are no request parameters for this operation.
- application/json;charset=utf-8
object
Adjust Balance Create
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 noncurrency adjustments, the bucket property is required.
-
@baseType: string
Title:
Base Type
The object's superclass. -
@schemaLocation: string
(uri)
Title:
Schema Location
A URI to a JSON schema file that defines additional attributes and relationships. (BRM does not use this property.) -
@type: string
Title:
Type
The object's subclass. -
adjustType: string
The type of adjustment. (BRM does not use this property.)
-
amount(required): object
object
Quantity
Title:
Quantity
The quantity of an object. -
bucket: object
object
Bucket Ref
Title:
Bucket Ref
A reference to a bucket. -
channel: object
object
ChannelRef
A reference to a channel.
-
confirmationDate: string
(date-time)
The date that the adjustment was confirmed. (BRM does not use this property.)
-
description: string
Title:
Description
The adjusted balance's description. -
impactedBucket: array
array
impactedBucket
A bucket impacted by the adjustment request.
-
logicalResource: object
object
Logical Resource Ref
Title:
Logical Resource Ref
A reference to a logical resource. -
partyAccount: object
object
Party Account Ref
Title:
Party Account Ref
A reference to a party account. -
product: object
object
Product Ref
Title:
Product Ref
A reference to a product. -
reason: string
Title:
Reason
The reason for the adjustment. - relatedParty: array array relatedParty
-
requestedDate: string
(date-time)
The date that the request was received.
-
requestor: object
object
Related Party
Title:
Related Party
A party related to another object. -
status: string
The adjustment's status.
-
usageType: string
The usage type for the adjustment. (BRM does not use this property.)
object
Quantity
-
amount: number
(float)
Title:
Amount
Default Value:1
A numeric value. -
units: string
Title:
Units
A unit. For example, MB or minutes.
object
Bucket Ref
-
@baseType: string
Title:
Base Type
The object's superclass. -
@referredType: string
Title:
Referred Type
The object's type in the target system, if baseType and type need further disambiguation. -
@schemaLocation: string
(uri)
Title:
Schema Location
A URI to a JSON schema file that defines additional attributes and relationships. -
@type: string
Title:
Type
The object's subclass. -
href: string
(uri)
The bucket's href.
-
id(required): string
Title:
Bucket ID
The bucket's ID. -
name: string
Title:
Bucket Name
The bucket's name. -
usageType: string
The bucket's usage type.
object
-
@baseType: string
Title:
Base Type
The object's superclass. -
@referredType: string
Title:
Referred Type
The object's type in the target system, if baseType and type need further disambiguation. -
@schemaLocation: string
(uri)
Title:
Schema Location
A URI to a JSON schema file that defines additional attributes and relationships. -
@type: string
Title:
Type
The object's subclass. -
href: string
Title:
Channel Href
The channel's href. -
id(required): string
Title:
Channel ID
The channel's ID. -
name: string
Title:
Channel Name
The channel's name.
array
-
Array of:
object ImpactedBucket
A bucket impacted by a balance top-up, adjustment, transfer, or reservation.
object
Logical Resource Ref
-
@baseType: string
Title:
Base Type
The object's superclass. -
@referredType: string
Title:
Referred Type
The object's type in the target system, if baseType and type need further disambiguation. -
@schemaLocation: string
(uri)
Title:
Schema Location
A URI to a JSON schema file that defines additional attributes and relationships. -
@type: string
Title:
Type
The object's subclass. -
href: string
Title:
Href
The resource's href. -
id(required): string
Title:
ID
The resource's ID. -
name: string
Title:
Name
The resource's name. -
value: string
The resource's value.
object
Party Account Ref
-
@baseType: string
Title:
Base Type
The object's superclass. -
@referredType: string
Title:
Referred Type
The object's type in the target system, if baseType and type need further disambiguation. -
@schemaLocation: string
(uri)
Title:
Schema Location
A URI to a JSON schema file that defines additional attributes and relationships. -
@type: string
Title:
Type
The object's subclass. -
description: string
Title:
Description
The party account's description. -
href: string
Title:
Href
The party account's href. -
id(required): string
Title:
Account ID
The party account's ID. -
name: string
Title:
Name
The party account's name. -
status: string
Title:
Status
The overall status of the account. For example, due, paid, or in arrears.
object
Product Ref
-
@baseType: string
Title:
Base Type
The object's superclass. -
@referredType: string
Title:
Referred Type
The object's type in the target system, if baseType and type need further disambiguation. -
@schemaLocation: string
(uri)
Title:
Schema Location
A URI to a JSON schema file that defines additional attributes and relationships. -
@type: string
Title:
Type
The object's subclass. -
href: string
Title:
Product Href
The product's href. -
id(required): string
Title:
Product ID
The product's ID. -
name: string
Title:
Product Name
The product's name.
object
Related Party
-
@baseType: string
Title:
Base Type
The object's superclass. -
@referredType(required): string
Title:
Referred Type
The object's type in the target system, if baseType and type need further disambiguation. -
@schemaLocation: string
(uri)
Title:
Schema Location
A URI to a JSON schema file that defines additional attributes and relationships. -
@type: string
Title:
Type
The object's subclass. -
href: string
(uri)
Title:
Href
The party's href. -
id(required): string
Title:
Party ID
The party's ID. -
name: string
Title:
Party Name
The party's name. -
role: string
Title:
Party Role
The party's role.
object
-
@baseType: string
The object's superclass.
-
@schemaLocation: string
(uri)
A URI to a JSON schema file that defines additional attributes and relationships.
-
@type: string
The object's subclass.
-
amountAfter: object
object
Quantity
Title:
Quantity
The quantity of an object. -
amountBefore: object
object
Quantity
Title:
Quantity
The quantity of an object. -
bucket: object
object
Bucket Ref
Title:
Bucket Ref
A reference to a bucket. -
confirmationDate: string
(date-time)
The date the impact was confirmed.
-
description: string
The impacted bucket's description.
-
item(required): array
array
item
Minimum Number of Items:
1
The impacted bucket items. -
name: string
The impacted bucket's name.
-
requestedDate: string
(date-time)
The date the request was received.
array
1
-
Array of:
object ImpactedBucketItem
An impact item that affects an ImpactedBucket object.
object
-
@baseType: string
The object's superclass.
-
@schemaLocation: string
(uri)
A URI to a JSON schema file that defines additional attributes and relationships.
-
@type: string
The object's subclass.
-
amount: object
object
Quantity
Title:
Quantity
The quantity of an object. -
description: string
The impact item's description.
-
itemType: string
The impact item's type, indicating if the bucket is incremented (credit) or decremented (debit).
-
name: string
The impact item's name, indicating the transaction activity. For example, top-up, bonus, additional bonus, tax, or fees.
-
reason: string
The reason for the impact item.
Response
- application/json;charset=utf-8
201 Response
object
Adjust Balance
-
@baseType: string
Title:
Base Type
The object's superclass. -
@schemaLocation: string
(uri)
Title:
Schema Location
A URI to a JSON schema file that defines additional attributes and relationships. (BRM does not use this property.) -
@type: string
Title:
Type
The object's subclass. -
adjustType: string
The adjustment type. (BRM does not use this property.)
-
amount: object
object
Quantity
Title:
Quantity
The quantity of an object. -
bucket: object
object
Bucket Ref
Title:
Bucket Ref
A reference to a bucket. -
channel: object
object
ChannelRef
A reference to a channel.
-
confirmationDate: string
(date-time)
Title:
Confirmation Date
The date that the adjustment was confirmed. -
description: string
Title:
Adjust Balance Description
The adjusted balance's description. -
href: string
(uri)
Title:
Adjust Balance Href
The adjusted balance's href. (BRM does not use this property.) -
id: string
Title:
Adjust Balance ID
The adjusted balance's ID. -
impactedBucket: array
array
impactedBucket
Buckets impacted by the adjustment. itself.
-
logicalResource: object
object
Logical Resource Ref
Title:
Logical Resource Ref
A reference to a logical resource. -
partyAccount: object
object
Party Account Ref
Title:
Party Account Ref
A reference to a party account. -
product: object
object
Product Ref
Title:
Product Ref
A reference to a product. -
reason:
Title:
Reason
The reason for the adjustment. - relatedParty: array array relatedParty
-
requestedDate: string
(date-time)
Title:
Requested Date
The date that the request was received. -
requestor: object
object
Related Party
Title:
Related Party
A party related to another object. -
status: string
The adjustment's status.
-
usageType: string
The usage type associated with the adjusted balance.
object
Quantity
-
amount: number
(float)
Title:
Amount
Default Value:1
A numeric value. -
units: string
Title:
Units
A unit. For example, MB or minutes.
object
Bucket Ref
-
@baseType: string
Title:
Base Type
The object's superclass. -
@referredType: string
Title:
Referred Type
The object's type in the target system, if baseType and type need further disambiguation. -
@schemaLocation: string
(uri)
Title:
Schema Location
A URI to a JSON schema file that defines additional attributes and relationships. -
@type: string
Title:
Type
The object's subclass. -
href: string
(uri)
The bucket's href.
-
id(required): string
Title:
Bucket ID
The bucket's ID. -
name: string
Title:
Bucket Name
The bucket's name. -
usageType: string
The bucket's usage type.
object
-
@baseType: string
Title:
Base Type
The object's superclass. -
@referredType: string
Title:
Referred Type
The object's type in the target system, if baseType and type need further disambiguation. -
@schemaLocation: string
(uri)
Title:
Schema Location
A URI to a JSON schema file that defines additional attributes and relationships. -
@type: string
Title:
Type
The object's subclass. -
href: string
Title:
Channel Href
The channel's href. -
id(required): string
Title:
Channel ID
The channel's ID. -
name: string
Title:
Channel Name
The channel's name.
array
-
Array of:
object ImpactedBucket
A bucket impacted by a balance top-up, adjustment, transfer, or reservation.
object
Logical Resource Ref
-
@baseType: string
Title:
Base Type
The object's superclass. -
@referredType: string
Title:
Referred Type
The object's type in the target system, if baseType and type need further disambiguation. -
@schemaLocation: string
(uri)
Title:
Schema Location
A URI to a JSON schema file that defines additional attributes and relationships. -
@type: string
Title:
Type
The object's subclass. -
href: string
Title:
Href
The resource's href. -
id(required): string
Title:
ID
The resource's ID. -
name: string
Title:
Name
The resource's name. -
value: string
The resource's value.
object
Party Account Ref
-
@baseType: string
Title:
Base Type
The object's superclass. -
@referredType: string
Title:
Referred Type
The object's type in the target system, if baseType and type need further disambiguation. -
@schemaLocation: string
(uri)
Title:
Schema Location
A URI to a JSON schema file that defines additional attributes and relationships. -
@type: string
Title:
Type
The object's subclass. -
description: string
Title:
Description
The party account's description. -
href: string
Title:
Href
The party account's href. -
id(required): string
Title:
Account ID
The party account's ID. -
name: string
Title:
Name
The party account's name. -
status: string
Title:
Status
The overall status of the account. For example, due, paid, or in arrears.
object
Product Ref
-
@baseType: string
Title:
Base Type
The object's superclass. -
@referredType: string
Title:
Referred Type
The object's type in the target system, if baseType and type need further disambiguation. -
@schemaLocation: string
(uri)
Title:
Schema Location
A URI to a JSON schema file that defines additional attributes and relationships. -
@type: string
Title:
Type
The object's subclass. -
href: string
Title:
Product Href
The product's href. -
id(required): string
Title:
Product ID
The product's ID. -
name: string
Title:
Product Name
The product's name.
object
Related Party
-
@baseType: string
Title:
Base Type
The object's superclass. -
@referredType(required): string
Title:
Referred Type
The object's type in the target system, if baseType and type need further disambiguation. -
@schemaLocation: string
(uri)
Title:
Schema Location
A URI to a JSON schema file that defines additional attributes and relationships. -
@type: string
Title:
Type
The object's subclass. -
href: string
(uri)
Title:
Href
The party's href. -
id(required): string
Title:
Party ID
The party's ID. -
name: string
Title:
Party Name
The party's name. -
role: string
Title:
Party Role
The party's role.
object
-
@baseType: string
The object's superclass.
-
@schemaLocation: string
(uri)
A URI to a JSON schema file that defines additional attributes and relationships.
-
@type: string
The object's subclass.
-
amountAfter: object
object
Quantity
Title:
Quantity
The quantity of an object. -
amountBefore: object
object
Quantity
Title:
Quantity
The quantity of an object. -
bucket: object
object
Bucket Ref
Title:
Bucket Ref
A reference to a bucket. -
confirmationDate: string
(date-time)
The date the impact was confirmed.
-
description: string
The impacted bucket's description.
-
item(required): array
array
item
Minimum Number of Items:
1
The impacted bucket items. -
name: string
The impacted bucket's name.
-
requestedDate: string
(date-time)
The date the request was received.
array
1
-
Array of:
object ImpactedBucketItem
An impact item that affects an ImpactedBucket object.
object
-
@baseType: string
The object's superclass.
-
@schemaLocation: string
(uri)
A URI to a JSON schema file that defines additional attributes and relationships.
-
@type: string
The object's subclass.
-
amount: object
object
Quantity
Title:
Quantity
The quantity of an object. -
description: string
The impact item's description.
-
itemType: string
The impact item's type, indicating if the bucket is incremented (credit) or decremented (debit).
-
name: string
The impact item's name, indicating the transaction activity. For example, top-up, bonus, additional bonus, tax, or fees.
-
reason: string
The reason for the impact item.
400 Response
object
Error
-
@baseType: string
Title:
Base Type
The object's superclass. -
@schemaLocation: string
(uri)
Title:
Schema Location
A URI to a JSON schema file that defines additional attributes and relationships. -
@type: string
Title:
Type
The object's subclass. -
code(required): string
Title:
Error Code
An error code. -
message: string
Title:
Error Message
Details and corrective actions related to the error. -
reason(required): string
Title:
Reason
The reason for the error. -
referenceError: string
(uri)
Title:
Reference Error
A URI to documentation describing the error. -
status: string
Title:
Error Status
The HTTP Error code extension.
401 Response
object
Error
-
@baseType: string
Title:
Base Type
The object's superclass. -
@schemaLocation: string
(uri)
Title:
Schema Location
A URI to a JSON schema file that defines additional attributes and relationships. -
@type: string
Title:
Type
The object's subclass. -
code(required): string
Title:
Error Code
An error code. -
message: string
Title:
Error Message
Details and corrective actions related to the error. -
reason(required): string
Title:
Reason
The reason for the error. -
referenceError: string
(uri)
Title:
Reference Error
A URI to documentation describing the error. -
status: string
Title:
Error Status
The HTTP Error code extension.
403 Response
object
Error
-
@baseType: string
Title:
Base Type
The object's superclass. -
@schemaLocation: string
(uri)
Title:
Schema Location
A URI to a JSON schema file that defines additional attributes and relationships. -
@type: string
Title:
Type
The object's subclass. -
code(required): string
Title:
Error Code
An error code. -
message: string
Title:
Error Message
Details and corrective actions related to the error. -
reason(required): string
Title:
Reason
The reason for the error. -
referenceError: string
(uri)
Title:
Reference Error
A URI to documentation describing the error. -
status: string
Title:
Error Status
The HTTP Error code extension.
405 Response
object
Error
-
@baseType: string
Title:
Base Type
The object's superclass. -
@schemaLocation: string
(uri)
Title:
Schema Location
A URI to a JSON schema file that defines additional attributes and relationships. -
@type: string
Title:
Type
The object's subclass. -
code(required): string
Title:
Error Code
An error code. -
message: string
Title:
Error Message
Details and corrective actions related to the error. -
reason(required): string
Title:
Reason
The reason for the error. -
referenceError: string
(uri)
Title:
Reference Error
A URI to documentation describing the error. -
status: string
Title:
Error Status
The HTTP Error code extension.
409 Response
object
Error
-
@baseType: string
Title:
Base Type
The object's superclass. -
@schemaLocation: string
(uri)
Title:
Schema Location
A URI to a JSON schema file that defines additional attributes and relationships. -
@type: string
Title:
Type
The object's subclass. -
code(required): string
Title:
Error Code
An error code. -
message: string
Title:
Error Message
Details and corrective actions related to the error. -
reason(required): string
Title:
Reason
The reason for the error. -
referenceError: string
(uri)
Title:
Reference Error
A URI to documentation describing the error. -
status: string
Title:
Error Status
The HTTP Error code extension.
500 Response
object
Error
-
@baseType: string
Title:
Base Type
The object's superclass. -
@schemaLocation: string
(uri)
Title:
Schema Location
A URI to a JSON schema file that defines additional attributes and relationships. -
@type: string
Title:
Type
The object's subclass. -
code(required): string
Title:
Error Code
An error code. -
message: string
Title:
Error Message
Details and corrective actions related to the error. -
reason(required): string
Title:
Reason
The reason for the error. -
referenceError: string
(uri)
Title:
Reference Error
A URI to documentation describing the error. -
status: string
Title:
Error Status
The HTTP Error code extension.
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" }