Get Adjusted Balances
/adjustBalance
Request
-
@type: string
The type of object to return.Example:
Use @type=AdjustBalance for a base object or @type=AdjustBalanceOracle for an extended object.
-
fields: string
The list of comma-separated fields to return in the response.Example:
fields=description,amount
-
id: string
Retrieves the adjustment with the specified ID.Example:
id=0.0.0.1+-item-adjustment+216265
-
limit: integer
The maximum number of results to return.Example:
Use limit=10 to return the first 10 results only.
-
offset: integer
The number of results to offset the response by.Example:
Use offset=10 to return results 10 and higher.
-
partyAccount.id: string
Retrieves the adjustments for the account with the specified ID.Example:
partyAccount.id=0.0.0.1+-account+70489
-
requestedDate: string
Retrieves the adjustments with a requestedDate that matches the specified date and time.Example:
requestedDate=2020-01-01T04:00:27-08:00
-
requestedDate.gt: string
Retrieves the adjustments with a requestedDate that is greater than the specified date and time.Example:
requestedDate.gt=2020-01-01T04:00:27-08:00
-
requestedDate.gte: string
Retrieves the adjustments with a requestedDate that is greater than or equal to the specified date and time.Example:
requestedDate.gte=2020-01-01T04:00:27-08:00
-
requestedDate.lt: string
Retrieves the adjustments with a requestedDate that is less than the specified date and time.Example:
requestedDate.lt=2020-01-01T04:00:27-08:00
-
requestedDate.lte: string
Retrieves the adjustments with a requestedDate that is less than or equal to the specified date and time.Example:
requestedDate.lte=2020-01-01T04:00:27-08:00
-
status: string
Retrieves the adjustment with the specified item status.Example:
Use status=completed to retrieve closed currency balance adjustments or status=created to retrieve open currency balance adjustments.
-
usageType: string
Retrieves adjustments that match the specified usage type. If usageType is not specified, only currency balance adjustments are retrieved.Example:
Use usageType=monetary to retrieve currency balance adjustments or usageType=other to retrieve non-currency balance adjustments.
There's no request body for this operation.
Back to TopResponse
- application/json;charset=utf-8
200 Response
-
X-Result-Count:
The number of items returned in the response body.
-
X-Total-Count:
The total number of items that matched the criteria.
array
-
Array of:
object Adjust Balance
Title:
Adjust Balance
An adjustment to a balance.
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. -
@type: string
Title:
Type
The object's subclass. -
adjustType: string
Title:
Adjust Type
Allowed Values:[ "recurring", "oneTime" ]
The type of adjustment. -
amount(required): object
Quantity
An amount in a given unit.
-
bucket: object
Bucket Ref
Title:
Bucket Ref
A reference to a bucket. -
channel: object
Channel Ref
Title:
Channel Ref
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
Title:
Adjust Balance Href
The adjusted balance's href. -
id(required): string
Title:
Adjust Balance ID
The adjusted balance's ID. -
logicalResource: array
logicalResource
Logical resources associated with the adjusted balance.
-
partyAccount: object
Party Account Ref
Title:
Party Account Ref
A reference to a party account. -
product: array
product
Products associated with the adjusted balance.
-
reason(required): string
Title:
Reason
The reason for the adjustment. - relatedParty: array relatedParty
-
requestedDate(required): string
(date-time)
Title:
Requested Date
The date that the request was received. -
requestor: object
Related Party
Title:
Related Party
A party related to another object. -
status(required): string
Title:
Action Status Type
Allowed Values:[ "created", "failed", "cancelled", "completed" ]
The status of an action. -
usageType: string
Title:
Usage Type
Allowed Values:[ "monetary", "voice", "data", "sms", "other" ]
The type of usage. For BRM REST Services Manager, only monetary and other are supported. -
validFor: object
TimePeriod
A period of time.
object
-
amount: number
(float)
Default Value:
1
Numeric value in a given unit. -
units: string
Unit
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
Title:
Bucket Href
The bucket's href. -
id(required): string
Title:
Bucket ID
The bucket's ID. -
name: string
Title:
Bucket Name
The bucket's name.
object
Channel 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:
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 Logical Resource Ref
Title:
Logical Resource Ref
A reference to a logical resource.
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.
array
-
Array of:
object Product Ref
Title:
Product Ref
A reference to a product.
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
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
-
endDateTime: string
(date-time)
Title:
End Time Period
The end of the time period in IETC-RFC-3339 format. -
startDateTime: string
(date-time)
Title:
Start Time Period
The start of the time period in IETC-RFC-3339 format.
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.
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.
400 Response
object
-
@baseType: string
This defines the super-class when sub-classing.
-
@schemaLocation: string
(uri)
A URI to a JSON-schema file that defines additional attributes and relationships.
-
@type: string
This defines the sub-class entity name when sub-classing.
-
code(required): string
Refers to application relevant detail, defined in the API or a common list.
-
message: string
More details and corrective actions related to the error which can be shown to a client user.
-
reason(required): string
Explanation of the reason for the error which can be shown to a client user.
-
referenceError: string
(uri)
URI of documentation describing the error.
-
status: string
Displays the HTTP error code extension.
401 Response
object
-
@baseType: string
This defines the super-class when sub-classing.
-
@schemaLocation: string
(uri)
A URI to a JSON-schema file that defines additional attributes and relationships.
-
@type: string
This defines the sub-class entity name when sub-classing.
-
code(required): string
Refers to application relevant detail, defined in the API or a common list.
-
message: string
More details and corrective actions related to the error which can be shown to a client user.
-
reason(required): string
Explanation of the reason for the error which can be shown to a client user.
-
referenceError: string
(uri)
URI of documentation describing the error.
-
status: string
Displays the HTTP error code extension.
403 Response
object
-
@baseType: string
This defines the super-class when sub-classing.
-
@schemaLocation: string
(uri)
A URI to a JSON-schema file that defines additional attributes and relationships.
-
@type: string
This defines the sub-class entity name when sub-classing.
-
code(required): string
Refers to application relevant detail, defined in the API or a common list.
-
message: string
More details and corrective actions related to the error which can be shown to a client user.
-
reason(required): string
Explanation of the reason for the error which can be shown to a client user.
-
referenceError: string
(uri)
URI of documentation describing the error.
-
status: string
Displays the HTTP error code extension.
404 Response
object
-
@baseType: string
This defines the super-class when sub-classing.
-
@schemaLocation: string
(uri)
A URI to a JSON-schema file that defines additional attributes and relationships.
-
@type: string
This defines the sub-class entity name when sub-classing.
-
code(required): string
Refers to application relevant detail, defined in the API or a common list.
-
message: string
More details and corrective actions related to the error which can be shown to a client user.
-
reason(required): string
Explanation of the reason for the error which can be shown to a client user.
-
referenceError: string
(uri)
URI of documentation describing the error.
-
status: string
Displays the HTTP error code extension.
405 Response
object
-
@baseType: string
This defines the super-class when sub-classing.
-
@schemaLocation: string
(uri)
A URI to a JSON-schema file that defines additional attributes and relationships.
-
@type: string
This defines the sub-class entity name when sub-classing.
-
code(required): string
Refers to application relevant detail, defined in the API or a common list.
-
message: string
More details and corrective actions related to the error which can be shown to a client user.
-
reason(required): string
Explanation of the reason for the error which can be shown to a client user.
-
referenceError: string
(uri)
URI of documentation describing the error.
-
status: string
Displays the HTTP error code extension.
409 Response
object
-
@baseType: string
This defines the super-class when sub-classing.
-
@schemaLocation: string
(uri)
A URI to a JSON-schema file that defines additional attributes and relationships.
-
@type: string
This defines the sub-class entity name when sub-classing.
-
code(required): string
Refers to application relevant detail, defined in the API or a common list.
-
message: string
More details and corrective actions related to the error which can be shown to a client user.
-
reason(required): string
Explanation of the reason for the error which can be shown to a client user.
-
referenceError: string
(uri)
URI of documentation describing the error.
-
status: string
Displays the HTTP error code extension.
500 Response
object
-
@baseType: string
This defines the super-class when sub-classing.
-
@schemaLocation: string
(uri)
A URI to a JSON-schema file that defines additional attributes and relationships.
-
@type: string
This defines the sub-class entity name when sub-classing.
-
code(required): string
Refers to application relevant detail, defined in the API or a common list.
-
message: string
More details and corrective actions related to the error which can be shown to a client user.
-
reason(required): string
Explanation of the reason for the error which can be shown to a client user.
-
referenceError: string
(uri)
URI of documentation describing the error.
-
status: string
Displays the HTTP error code extension.
Examples
The following examples shows how to get balance adjustments by submitting a GET request on the REST resource using cURL. For more information about cURL, see Use cURL.
Examples of the Request Body
This request uses the usageType=monetary query parameter to return only currency adjustments:
curl -X GET 'http://host:port/brm/prepayBalanceManagement/version/adjustBalance?limit=2&usageType=monetary'
This request uses the usageType=other query parameter to return only noncurrency adjustments:
curl -X GET 'http://host:port/brm/prepayBalanceManagement/version/adjustBalance?limit=1&usageType=other'
Example of the Response Body for Currency Adjustments
The following example shows the contents of the response body for currency adjustments in JSON format.
[ { "id": "0.0.0.1+-item-adjustment+221139", "href": "http://host:port/brm/prepayBalanceManagement/version/adjustBalance/0.0.0.1+-item-adjustment+221139", "confirmationDate": "2020-01-08T07:35:58-08:00", "description": "", "reason": "1", "requestedDate": "2020-01-08T07:35:58-08:00", "adjustType": null, "amount": { "amount": -1.0, "units": "USD", "@baseType": null, "@schemaLocation": null, "@type": null }, "bucket": null, "channel": null, "logicalResource": null, "partyAccount": { "id": "0.0.0.1+-account+228862", "href": null, "description": null, "name": "Daniel R", "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": "MONETARY", "validFor": null, "@baseType": "AdjustBalance", "@schemaLocation": null, "@type": "AdjustBalance" }, { "id": "0.0.0.1+-item-adjustment+220881", "href": "http://host:port/brm/prepayBalanceManagement/version/adjustBalance/0.0.0.1+-item-adjustment+220881", "confirmationDate": "2020-01-08T07:34:40-08:00", "description": "", "reason": "1", "requestedDate": "2020-01-08T07:34:40-08:00", "adjustType": null, "amount": { "amount": -3.0, "units": "USD", "@baseType": null, "@schemaLocation": null, "@type": null }, "bucket": null, "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": "MONETARY", "validFor": null, "@baseType": "AdjustBalance", "@schemaLocation": null, "@type": "AdjustBalance" } ]
Example of the Response Body for Noncurrency Adjustments
The following example shows the contents of the response body for noncurrency adjustments in JSON format.
[ { "id": "0.0.0.1+-event-billing-debit+32593", "href": "http://host:port/brm/prepayBalanceManagement/v4/adjustBalance/0.0.0.1+-event-billing-debit+32593", "confirmationDate": "2020-09-22T23:20:56+05:30", "description": "My Noncurrency Adjustment", "reason": "1", "requestedDate": "2020-09-22T23:20:56+05:30", "adjustType": null, "amount": { "amount": 1.0, "units": "Free Game", "@baseType": null, "@schemaLocation": null, "@type": null }, "bucket": { "id": "0.0.0.1+-balance_group+57356", "href": "http://host:port/brm/prepayBalanceManagement/v4/bucket/0.0.0.1+-balance_group+57356", "name": null, "@baseType": "Bucket", "@schemaLocation": null, "@type": "Bucket", "@referredType": null }, "channel": null, "logicalResource": null, "partyAccount": { "id": "0.0.0.1+-account+59892", "href": null, "description": null, "name": "acc01 acc01", "status": "active", "@baseType": null, "@schemaLocation": null, "@type": null, "@referredType": null }, "product": null, "relatedParty": null, "requestor": { "id": null, "href": null, "name": "brm-rest-services-manager", "role": null, "@baseType": null, "@schemaLocation": null, "@type": null, "@referredType": null }, "status": null, "usageType": "OTHER", "validFor": { "endDateTime": "2022-10-21T13:14:53+05:30", "startDateTime": "2020-10-21T13:14:53+05:30" }, "@baseType": "AdjustBalance", "@schemaLocation": null, "@type": "AdjustBalance" } ]