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

Get Accumulated Balances

get

/accumulatedBalance

Gets accumulated balances that match the query criteria.

Request

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=totalBalance,bucket
  • Returns the accumulated balances for the account with the specified ID.
    Example:
    id=0.0.0.1+-account+102879
  • The maximum number of results to return.
    Example:
    Use limit=10 to return the first 10 results only.
  • The number of results to offset the response by.
    Example:
    Use offset=10 to return results 10 and higher.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

200 Response

Success
Headers
Body ()
Root Schema : schema
Type: array
Show Source
Nested 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 accumulated balances by submitting a GET request on the REST resource using cURL. For more information about cURL, see Use cURL.

The request uses query parameters to show a single accumulated balance object and only display certain fields.

curl -X GET 'http://host:port/brm/prepayBalanceManagement/version/accumulatedBalance?fields=bucket,partyAccount,product,totalBalance,nonCurrency&limit=1'

Example of the Response Body

The following example shows the contents of the response body in JSON format. Because the request included only bucket, partyAccount, product, totalBalance, and nonCurrency in the fields query parameter, these are the only details shown, other than id and href. 

[
    {
        "id": "0.0.0.1+-account+102879",
        "href": "http://host:port/brm/prepayBalanceManagement/version/accumulatedBalance/0.0.0.1+-account+102879",
        "description": null,
        "name": null,
        "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 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": null,
        "@schemaLocation": null,
        "@type": null
    }
]
Back to Top