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

Get Adjusted Balances

get

/adjustBalance

Gets the adjusted balances that match the query criteria.

Request

Query Parameters
  • The type of object to return. Use @type=AdjustBalance for a base object, or @type=AdjustBalanceOracle for an extended object.
  • The list of comma-separated fields to return in the response.
    Examples

  • Retrieves the adjustment with the specified adjustment ID or adjustment number.
    Examples

  • The maximum number of results to return.
    Examples

  • The number of results to offset the response by.
    Examples

  • Retrieves the adjustments for the account with the specified account ID or account number.
    Examples

  • Retrieves the adjustments with a requestedDate that matches the specified date and time.
    Examples

  • Retrieves the adjustments with a requestedDate that is greater than the specified date and time.
    Examples

  • Retrieves the adjustments with a requestedDate that is greater than or equal to the specified date and time.
    Examples

  • Retrieves the adjustments with a requestedDate that is less than the specified date and time.
    Examples

  • Retrieves the adjustments with a requestedDate that is less than or equal to the specified date and time.
    Examples

  • Retrieves the adjustment with the specified item status. Use status=completed to retrieve closed currency balance adjustments or status=created to retrieve open currency balance adjustments.
  • Retrieves adjustments that match the specified usage type. Use usageType=monetary to retrieve currency balance adjustments. Use usageType=other to retrieve non-currency balance adjustments.

    If usageType is not specified, only currency balance adjustments are retrieved.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

200 Response

The adjusted balances were retrieved successfully.
Headers
Body ()
Root Schema : schema
Type: array
Show Source
Nested Schema : Adjust Balance
Type: object
Title: Adjust Balance
An adjustment to a balance.
Show Source
Nested Schema : Quantity
Type: object
The 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 : ChannelRef
Type: object
A reference to a channel.
Show Source
Nested Schema : impactedBucket
Type: array
Buckets impacted by the adjustment. itself.
Show Source
Nested Schema : Logical Resource Ref
Type: object
Title: Logical Resource Ref
A reference to a logical resource.
Show Source
Nested Schema : Party Account Ref
Type: object
Title: Party Account Ref
A reference to a party account.
Show Source
Nested Schema : Product Ref
Type: object
Title: Product Ref
A reference to a product.
Show Source
Nested Schema : relatedParty
Type: array
The parties related to the adjusted balance. (BRM does not use this property.)
Show Source
Nested Schema : Related Party
Type: object
Title: Related Party
A party related to another object.
Show Source
Nested Schema : ImpactedBucket
Type: object
A bucket impacted by a balance top-up, adjustment, transfer, or reservation.
Show Source
Nested Schema : item
Type: array
Minimum Number of Items: 1
The impacted bucket items.
Show Source
Nested Schema : ImpactedBucketItem
Type: object
An impact item that affects an ImpactedBucket object.
Show Source

400 Response

The request isn't valid.
Body ()
Root Schema : Error
The operation used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx).
Match All
The operation used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx).
The operation used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx).
Show Source
  • Extensible
    The Base Extensible schema for use in TMForum Open-APIs - When used for in a schema it means that the Entity described by the schema MUST be extended with the @type
  • Error-allOf[1]
Nested Schema : Extensible
Type: object
The Base Extensible schema for use in TMForum Open-APIs - When used for in a schema it means that the Entity described by the schema MUST be extended with the @type
Show Source
Nested Schema : Error-allOf[1]
Type: object
Show Source

401 Response

The client doesn't have the correct privileges.
Body ()
Root Schema : Error
The operation used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx).
Match All
The operation used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx).
The operation used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx).
Show Source
  • Extensible
    The Base Extensible schema for use in TMForum Open-APIs - When used for in a schema it means that the Entity described by the schema MUST be extended with the @type
  • Error-allOf[1]
Nested Schema : Extensible
Type: object
The Base Extensible schema for use in TMForum Open-APIs - When used for in a schema it means that the Entity described by the schema MUST be extended with the @type
Show Source
Nested Schema : Error-allOf[1]
Type: object
Show Source

403 Response

The request wasn't authorized.
Body ()
Root Schema : Error
The operation used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx).
Match All
The operation used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx).
The operation used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx).
Show Source
  • Extensible
    The Base Extensible schema for use in TMForum Open-APIs - When used for in a schema it means that the Entity described by the schema MUST be extended with the @type
  • Error-allOf[1]
Nested Schema : Extensible
Type: object
The Base Extensible schema for use in TMForum Open-APIs - When used for in a schema it means that the Entity described by the schema MUST be extended with the @type
Show Source
Nested Schema : Error-allOf[1]
Type: object
Show Source

404 Response

The requested resource couldn't be found.
Body ()
Root Schema : Error
The operation used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx).
Match All
The operation used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx).
The operation used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx).
Show Source
  • Extensible
    The Base Extensible schema for use in TMForum Open-APIs - When used for in a schema it means that the Entity described by the schema MUST be extended with the @type
  • Error-allOf[1]
Nested Schema : Extensible
Type: object
The Base Extensible schema for use in TMForum Open-APIs - When used for in a schema it means that the Entity described by the schema MUST be extended with the @type
Show Source
Nested Schema : Error-allOf[1]
Type: object
Show Source

405 Response

This method is not allowed.
Body ()
Root Schema : Error
The operation used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx).
Match All
The operation used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx).
The operation used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx).
Show Source
  • Extensible
    The Base Extensible schema for use in TMForum Open-APIs - When used for in a schema it means that the Entity described by the schema MUST be extended with the @type
  • Error-allOf[1]
Nested Schema : Extensible
Type: object
The Base Extensible schema for use in TMForum Open-APIs - When used for in a schema it means that the Entity described by the schema MUST be extended with the @type
Show Source
Nested Schema : Error-allOf[1]
Type: object
Show Source

409 Response

The request could not be processed due to the conflict with the existing state of the resource.
Body ()
Root Schema : Error
The operation used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx).
Match All
The operation used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx).
The operation used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx).
Show Source
  • Extensible
    The Base Extensible schema for use in TMForum Open-APIs - When used for in a schema it means that the Entity described by the schema MUST be extended with the @type
  • Error-allOf[1]
Nested Schema : Extensible
Type: object
The Base Extensible schema for use in TMForum Open-APIs - When used for in a schema it means that the Entity described by the schema MUST be extended with the @type
Show Source
Nested Schema : Error-allOf[1]
Type: object
Show Source

500 Response

The system encountered an internal error.
Body ()
Root Schema : Error
The operation used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx).
Match All
The operation used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx).
The operation used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx).
Show Source
  • Extensible
    The Base Extensible schema for use in TMForum Open-APIs - When used for in a schema it means that the Entity described by the schema MUST be extended with the @type
  • Error-allOf[1]
Nested Schema : Extensible
Type: object
The Base Extensible schema for use in TMForum Open-APIs - When used for in a schema it means that the Entity described by the schema MUST be extended with the @type
Show Source
Nested Schema : Error-allOf[1]
Type: object
Show Source
Back to Top

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": "2025-01-08T07:35:58-08:00",
        "description": "",
        "reason": "1",
        "requestedDate": "2025-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": "2025-01-08T07:34:40-08:00",
        "description": "",
        "reason": "1",
        "requestedDate": "2025-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": "2025-09-22T23:20:56+05:30",
        "description": "My Noncurrency Adjustment",
        "reason": "1",
        "requestedDate": "2025-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": "2025-10-21T13:14:53+05:30",
            "startDateTime": "2025-10-21T13:14:53+05:30"
        },
        "@baseType": "AdjustBalance",
        "@schemaLocation": null,
        "@type": "AdjustBalance"
    }
]
Back to Top