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

Get an Accumulated Balance by ID

get

/accumulatedBalance/{id}

Gets the specified accumulated balance.

Request

Path Parameters
  • The ID of the account to get the accumulated balance for.
    Example:
    0.0.0.1+-account+102879
Query Parameters
  • The type of object to return.
    Example:
    Use @type=AccumulatedBalance for a base object, or @type=AccumulatedBalanceOracle for an extended object.
  • The list of comma-separated fields to return in the response.
    Example:
    fields=bucket,name

There's no request body for this operation.

Back to Top

Response

Supported Media Types

200 Response

Success
Body ()
Root Schema : Accumulated Balance
Type: object
Title: Accumulated Balance
An amount owed by an account, aggregating amounts contained in a set of buckets.
Show Source
Nested Schema : bucket
Type: array
Minimum Number of Items: 1
The buckets containing the accumulated balance.
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
Type: array
Products associated with the accumulated balance.
Show Source
Nested Schema : relatedParty
Type: array
Parties related to the accumulated 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 : Product Ref
Type: object
Title: Product Ref
A reference to a product.
Show Source
Nested Schema : Related Party
Type: object
Title: Related Party
A party related to another object.
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

404 Response

Not Found
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 get the accumulated balance for the account with the specified ID by submitting a GET request on the REST resource using cURL. For more information about cURL, see Use cURL. 

curl -X GET 'http://host:port/brm/prepayBalanceManagement/version/accumulatedBalance/0.0.0.1+-account+102879'

Example of the Response Body

The following example shows the contents of the response body in JSON format.

{
    "id": "0.0.0.1+-account+102879",
    "href": "http://host:port/brm/prepayBalanceManagement/version/accumulatedBalance/0.0.0.1+-account+102879",
    "description": null,
    "name": "James Kurup",
    "bucket": [
        {
            "id": "0.0.0.1+-balance_group+106463",
            "href": "http://host:port/brm/prepayBalanceManagement/version/bucket/0.0.0.1+-balance_group+106463",
            "name": "Account Level Balance Group",
            "@baseType": null,
            "@schemaLocation": null,
            "@type": "BucketRef",
            "@referredType": null
        }
    ],
    "logicalResource": null,
    "partyAccount": {
        "id": "0.0.0.1+-account+102879",
        "href": null,
        "description": null,
        "name": "James Kurup",
        "status": "active",
        "@baseType": null,
        "@schemaLocation": null,
        "@type": "PartyAccountRef",
        "@referredType": null
    },
    "product": [
        {
            "id": "0.0.0.1+-service-telco-gsm-sms+102975",
            "href": null,
            "name": "ServiceTelcoGsmSms",
            "@baseType": null,
            "@schemaLocation": null,
            "@type": "ProductRef",
            "@referredType": null
        },
        {
            "id": "0.0.0.1+-service-telco-gsm-telephony+104255",
            "href": null,
            "name": "ServiceTelcoGsmTelephony",
            "@baseType": null,
            "@schemaLocation": null,
            "@type": "ProductRef",
            "@referredType": null
        }
    ],
    "relatedParty": null,
    "totalBalance": {
        "amount": 45.0,
        "units": "EUR",
        "@baseType": null,
        "@schemaLocation": null,
        "@type": "Quantity"
    },
    "@baseType": "AccumulatedBalance",
    "@schemaLocation": null,
    "@type": "AccumulatedBalance"
}
Back to Top