Jump to

• Request
• Response
• Examples

Get Accumulated Balances

get

/accumulatedBalance

Gets accumulated balances that match the query criteria.

Request

Query Parameters

• @type: string
  The type of object to return. Use @type=AccumulatedBalance for a base object, or @type=AccumulatedBalanceOracle for an extended object.
• billStructure.id: string
  Specifies the bill structure's ID to filter accumulated balances. Use @type=AccumulatedBalanceOracle for the extended response. When the request filters by billStructure.id, the response includes billStructure and sets billingCycleSpecification to null.

  Examples

  Select an example billStructure.id=test_bill_structure_174268

• billingCycleSpecification.id: string
  Specifies the billing cycle specification's POID to filter accumulated balances. Use @type=AccumulatedBalanceOracle for the extended response.

  Example:

  0.0.0.1+-billinfo+174685

• fields: string
  The list of comma-separated fields to return in the response.

  Examples

  Select an example fields=totalBalance,bucket

• id: string
  The internal account ID or external account ID.

  Examples

  Select an example id=0.0.0.1+-account+102879

• limit: integer
  The maximum number of results to return.

  Examples

  Select an example Use limit=10 to return the first 10 results only.

• logicalResource.value: string
  Retrieves accumulated balances associated with the specified login ID or device ID.

  Example:

  710-20211115-091333-0-27507--147359168-phx-111

• offset: integer
  The number of results to offset the response by.

  Examples

  Select an example Use offset=10 to return results 10 and higher.

• partyAccount.id: string
  Retrieves the accumulated balance associated with the account external ID or account POID.

  Examples

  Select an example partyAccount.id=0.0.0.1+-account+102879 partyAccount.id=test_acc_14080

• product.id: string
  Retrieves the accumulated balances associated with the specified service POID, login ID or alias name.

  Examples

  Select an example product.id=0.0.0.1+-service-telco-gsm-telephony+2081030 product.id=aliasGSM_1101

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json;charset=utf-8

200 Response

The accumulated balances were retrieved successfully.

Headers

• X-Result-Count:
  The number of items returned in the response body.
• X-Total-Count:
  The total number of items that matched the criteria.

Body ()

Root Schema : schema

Type: array

Show Source

• Array of:

{
    "type":"array",
    "items":{
        "anyOf":[
            {
                "$ref":"#/components/schemas/AccumulatedBalance"
            },
            {
                "$ref":"#/components/schemas/AccumulatedBalanceOracle"
            }
        ]
    }
}

400 Response

The request isn't valid.

Body ()

Root Schema : Error

Represents an error returned by an API, typically with an HTTP 3xx, 4xx, or 5xx response code.

Match All

Represents an error returned by an API, typically with an HTTP 3xx, 4xx, or 5xx response code.

Represents an error returned by an API, typically with an HTTP 3xx, 4xx, or 5xx response code.

Show Source

• object Extensible
  Represents a base extensible schema for TM Forum Open APIs. The entity must include @type.
• object Error-allOf[1]

{
    "allOf":[
        {
            "$ref":"#/components/schemas/Extensible"
        },
        {
            "type":"object",
            "required":[
                "code",
                "reason"
            ],
            "properties":{
                "code":{
                    "type":"string",
                    "description":"The application-specific error detail defined by the API or a common list."
                },
                "reason":{
                    "type":"string",
                    "description":"Explains the error to a client user."
                },
                "message":{
                    "type":"string",
                    "description":"Provides error details and corrective actions for a client user."
                },
                "status":{
                    "type":"string",
                    "description":"The HTTP error code extension."
                },
                "referenceError":{
                    "type":"string",
                    "description":"The URI of documentation that describes the error."
                }
            }
        }
    ],
    "description":"Represents an error returned by an API, typically with an HTTP 3xx, 4xx, or 5xx response code."
}

Nested Schema : Extensible

Type: object

Represents a base extensible schema for TM Forum Open APIs. The entity must include @type.

Show Source

• @baseType: string
  The superclass.
• @schemaLocation: string
  The URI of a JSON Schema file that defines additional attributes and relationships.
• @type(required): string
  The subclass Extensible name.

{
    "type":"object",
    "description":"Represents a base extensible schema for TM Forum Open APIs. The entity must include @type.",
    "properties":{
        "@type":{
            "type":"string",
            "nullable":true,
            "description":"The subclass Extensible name."
        },
        "@baseType":{
            "type":"string",
            "nullable":true,
            "description":"The superclass."
        },
        "@schemaLocation":{
            "type":"string",
            "nullable":true,
            "description":"The URI of a JSON Schema file that defines additional attributes and relationships."
        }
    },
    "required":[
        "@type"
    ]
}

Nested Schema : Error-allOf[1]

Type: object

Show Source

• code(required): string
  The application-specific error detail defined by the API or a common list.
• message: string
  Provides error details and corrective actions for a client user.
• reason(required): string
  Explains the error to a client user.
• referenceError: string
  The URI of documentation that describes the error.
• status: string
  The HTTP error code extension.

{
    "type":"object",
    "required":[
        "code",
        "reason"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"The application-specific error detail defined by the API or a common list."
        },
        "reason":{
            "type":"string",
            "description":"Explains the error to a client user."
        },
        "message":{
            "type":"string",
            "description":"Provides error details and corrective actions for a client user."
        },
        "status":{
            "type":"string",
            "description":"The HTTP error code extension."
        },
        "referenceError":{
            "type":"string",
            "description":"The URI of documentation that describes the error."
        }
    }
}

401 Response

The client doesn't have the correct privileges.

Body ()

Root Schema : Error

Represents an error returned by an API, typically with an HTTP 3xx, 4xx, or 5xx response code.

Match All

Represents an error returned by an API, typically with an HTTP 3xx, 4xx, or 5xx response code.

Represents an error returned by an API, typically with an HTTP 3xx, 4xx, or 5xx response code.

Show Source

• object Extensible
  Represents a base extensible schema for TM Forum Open APIs. The entity must include @type.
• object Error-allOf[1]

{
    "allOf":[
        {
            "$ref":"#/components/schemas/Extensible"
        },
        {
            "type":"object",
            "required":[
                "code",
                "reason"
            ],
            "properties":{
                "code":{
                    "type":"string",
                    "description":"The application-specific error detail defined by the API or a common list."
                },
                "reason":{
                    "type":"string",
                    "description":"Explains the error to a client user."
                },
                "message":{
                    "type":"string",
                    "description":"Provides error details and corrective actions for a client user."
                },
                "status":{
                    "type":"string",
                    "description":"The HTTP error code extension."
                },
                "referenceError":{
                    "type":"string",
                    "description":"The URI of documentation that describes the error."
                }
            }
        }
    ],
    "description":"Represents an error returned by an API, typically with an HTTP 3xx, 4xx, or 5xx response code."
}

Nested Schema : Extensible

Type: object

Represents a base extensible schema for TM Forum Open APIs. The entity must include @type.

Show Source

• @baseType: string
  The superclass.
• @schemaLocation: string
  The URI of a JSON Schema file that defines additional attributes and relationships.
• @type(required): string
  The subclass Extensible name.

{
    "type":"object",
    "description":"Represents a base extensible schema for TM Forum Open APIs. The entity must include @type.",
    "properties":{
        "@type":{
            "type":"string",
            "nullable":true,
            "description":"The subclass Extensible name."
        },
        "@baseType":{
            "type":"string",
            "nullable":true,
            "description":"The superclass."
        },
        "@schemaLocation":{
            "type":"string",
            "nullable":true,
            "description":"The URI of a JSON Schema file that defines additional attributes and relationships."
        }
    },
    "required":[
        "@type"
    ]
}

Nested Schema : Error-allOf[1]

Type: object

Show Source

• code(required): string
  The application-specific error detail defined by the API or a common list.
• message: string
  Provides error details and corrective actions for a client user.
• reason(required): string
  Explains the error to a client user.
• referenceError: string
  The URI of documentation that describes the error.
• status: string
  The HTTP error code extension.

{
    "type":"object",
    "required":[
        "code",
        "reason"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"The application-specific error detail defined by the API or a common list."
        },
        "reason":{
            "type":"string",
            "description":"Explains the error to a client user."
        },
        "message":{
            "type":"string",
            "description":"Provides error details and corrective actions for a client user."
        },
        "status":{
            "type":"string",
            "description":"The HTTP error code extension."
        },
        "referenceError":{
            "type":"string",
            "description":"The URI of documentation that describes the error."
        }
    }
}

403 Response

The request wasn't authorized.

Body ()

Root Schema : Error

Represents an error returned by an API, typically with an HTTP 3xx, 4xx, or 5xx response code.

Match All

Represents an error returned by an API, typically with an HTTP 3xx, 4xx, or 5xx response code.

Represents an error returned by an API, typically with an HTTP 3xx, 4xx, or 5xx response code.

Show Source

• object Extensible
  Represents a base extensible schema for TM Forum Open APIs. The entity must include @type.
• object Error-allOf[1]

{
    "allOf":[
        {
            "$ref":"#/components/schemas/Extensible"
        },
        {
            "type":"object",
            "required":[
                "code",
                "reason"
            ],
            "properties":{
                "code":{
                    "type":"string",
                    "description":"The application-specific error detail defined by the API or a common list."
                },
                "reason":{
                    "type":"string",
                    "description":"Explains the error to a client user."
                },
                "message":{
                    "type":"string",
                    "description":"Provides error details and corrective actions for a client user."
                },
                "status":{
                    "type":"string",
                    "description":"The HTTP error code extension."
                },
                "referenceError":{
                    "type":"string",
                    "description":"The URI of documentation that describes the error."
                }
            }
        }
    ],
    "description":"Represents an error returned by an API, typically with an HTTP 3xx, 4xx, or 5xx response code."
}

Nested Schema : Extensible

Type: object

Represents a base extensible schema for TM Forum Open APIs. The entity must include @type.

Show Source

• @baseType: string
  The superclass.
• @schemaLocation: string
  The URI of a JSON Schema file that defines additional attributes and relationships.
• @type(required): string
  The subclass Extensible name.

{
    "type":"object",
    "description":"Represents a base extensible schema for TM Forum Open APIs. The entity must include @type.",
    "properties":{
        "@type":{
            "type":"string",
            "nullable":true,
            "description":"The subclass Extensible name."
        },
        "@baseType":{
            "type":"string",
            "nullable":true,
            "description":"The superclass."
        },
        "@schemaLocation":{
            "type":"string",
            "nullable":true,
            "description":"The URI of a JSON Schema file that defines additional attributes and relationships."
        }
    },
    "required":[
        "@type"
    ]
}

Nested Schema : Error-allOf[1]

Type: object

Show Source

• code(required): string
  The application-specific error detail defined by the API or a common list.
• message: string
  Provides error details and corrective actions for a client user.
• reason(required): string
  Explains the error to a client user.
• referenceError: string
  The URI of documentation that describes the error.
• status: string
  The HTTP error code extension.

{
    "type":"object",
    "required":[
        "code",
        "reason"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"The application-specific error detail defined by the API or a common list."
        },
        "reason":{
            "type":"string",
            "description":"Explains the error to a client user."
        },
        "message":{
            "type":"string",
            "description":"Provides error details and corrective actions for a client user."
        },
        "status":{
            "type":"string",
            "description":"The HTTP error code extension."
        },
        "referenceError":{
            "type":"string",
            "description":"The URI of documentation that describes the error."
        }
    }
}

404 Response

The requested resource couldn't be found.

Body ()

Root Schema : Error

Represents an error returned by an API, typically with an HTTP 3xx, 4xx, or 5xx response code.

Match All

Represents an error returned by an API, typically with an HTTP 3xx, 4xx, or 5xx response code.

Represents an error returned by an API, typically with an HTTP 3xx, 4xx, or 5xx response code.

Show Source

• object Extensible
  Represents a base extensible schema for TM Forum Open APIs. The entity must include @type.
• object Error-allOf[1]

{
    "allOf":[
        {
            "$ref":"#/components/schemas/Extensible"
        },
        {
            "type":"object",
            "required":[
                "code",
                "reason"
            ],
            "properties":{
                "code":{
                    "type":"string",
                    "description":"The application-specific error detail defined by the API or a common list."
                },
                "reason":{
                    "type":"string",
                    "description":"Explains the error to a client user."
                },
                "message":{
                    "type":"string",
                    "description":"Provides error details and corrective actions for a client user."
                },
                "status":{
                    "type":"string",
                    "description":"The HTTP error code extension."
                },
                "referenceError":{
                    "type":"string",
                    "description":"The URI of documentation that describes the error."
                }
            }
        }
    ],
    "description":"Represents an error returned by an API, typically with an HTTP 3xx, 4xx, or 5xx response code."
}

Nested Schema : Extensible

Type: object

Represents a base extensible schema for TM Forum Open APIs. The entity must include @type.

Show Source

• @baseType: string
  The superclass.
• @schemaLocation: string
  The URI of a JSON Schema file that defines additional attributes and relationships.
• @type(required): string
  The subclass Extensible name.

{
    "type":"object",
    "description":"Represents a base extensible schema for TM Forum Open APIs. The entity must include @type.",
    "properties":{
        "@type":{
            "type":"string",
            "nullable":true,
            "description":"The subclass Extensible name."
        },
        "@baseType":{
            "type":"string",
            "nullable":true,
            "description":"The superclass."
        },
        "@schemaLocation":{
            "type":"string",
            "nullable":true,
            "description":"The URI of a JSON Schema file that defines additional attributes and relationships."
        }
    },
    "required":[
        "@type"
    ]
}

Nested Schema : Error-allOf[1]

Type: object

Show Source

• code(required): string
  The application-specific error detail defined by the API or a common list.
• message: string
  Provides error details and corrective actions for a client user.
• reason(required): string
  Explains the error to a client user.
• referenceError: string
  The URI of documentation that describes the error.
• status: string
  The HTTP error code extension.

{
    "type":"object",
    "required":[
        "code",
        "reason"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"The application-specific error detail defined by the API or a common list."
        },
        "reason":{
            "type":"string",
            "description":"Explains the error to a client user."
        },
        "message":{
            "type":"string",
            "description":"Provides error details and corrective actions for a client user."
        },
        "status":{
            "type":"string",
            "description":"The HTTP error code extension."
        },
        "referenceError":{
            "type":"string",
            "description":"The URI of documentation that describes the error."
        }
    }
}

405 Response

This method is not allowed.

Body ()

Root Schema : Error

Represents an error returned by an API, typically with an HTTP 3xx, 4xx, or 5xx response code.

Match All

Represents an error returned by an API, typically with an HTTP 3xx, 4xx, or 5xx response code.

Represents an error returned by an API, typically with an HTTP 3xx, 4xx, or 5xx response code.

Show Source

• object Extensible
  Represents a base extensible schema for TM Forum Open APIs. The entity must include @type.
• object Error-allOf[1]

{
    "allOf":[
        {
            "$ref":"#/components/schemas/Extensible"
        },
        {
            "type":"object",
            "required":[
                "code",
                "reason"
            ],
            "properties":{
                "code":{
                    "type":"string",
                    "description":"The application-specific error detail defined by the API or a common list."
                },
                "reason":{
                    "type":"string",
                    "description":"Explains the error to a client user."
                },
                "message":{
                    "type":"string",
                    "description":"Provides error details and corrective actions for a client user."
                },
                "status":{
                    "type":"string",
                    "description":"The HTTP error code extension."
                },
                "referenceError":{
                    "type":"string",
                    "description":"The URI of documentation that describes the error."
                }
            }
        }
    ],
    "description":"Represents an error returned by an API, typically with an HTTP 3xx, 4xx, or 5xx response code."
}

Nested Schema : Extensible

Type: object

Represents a base extensible schema for TM Forum Open APIs. The entity must include @type.

Show Source

• @baseType: string
  The superclass.
• @schemaLocation: string
  The URI of a JSON Schema file that defines additional attributes and relationships.
• @type(required): string
  The subclass Extensible name.

{
    "type":"object",
    "description":"Represents a base extensible schema for TM Forum Open APIs. The entity must include @type.",
    "properties":{
        "@type":{
            "type":"string",
            "nullable":true,
            "description":"The subclass Extensible name."
        },
        "@baseType":{
            "type":"string",
            "nullable":true,
            "description":"The superclass."
        },
        "@schemaLocation":{
            "type":"string",
            "nullable":true,
            "description":"The URI of a JSON Schema file that defines additional attributes and relationships."
        }
    },
    "required":[
        "@type"
    ]
}

Nested Schema : Error-allOf[1]

Type: object

Show Source

• code(required): string
  The application-specific error detail defined by the API or a common list.
• message: string
  Provides error details and corrective actions for a client user.
• reason(required): string
  Explains the error to a client user.
• referenceError: string
  The URI of documentation that describes the error.
• status: string
  The HTTP error code extension.

{
    "type":"object",
    "required":[
        "code",
        "reason"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"The application-specific error detail defined by the API or a common list."
        },
        "reason":{
            "type":"string",
            "description":"Explains the error to a client user."
        },
        "message":{
            "type":"string",
            "description":"Provides error details and corrective actions for a client user."
        },
        "status":{
            "type":"string",
            "description":"The HTTP error code extension."
        },
        "referenceError":{
            "type":"string",
            "description":"The URI of documentation that describes the error."
        }
    }
}

409 Response

The request could not be processed due to the conflict with the existing state of the resource.

Body ()

Root Schema : Error

Represents an error returned by an API, typically with an HTTP 3xx, 4xx, or 5xx response code.

Match All

Represents an error returned by an API, typically with an HTTP 3xx, 4xx, or 5xx response code.

Represents an error returned by an API, typically with an HTTP 3xx, 4xx, or 5xx response code.

Show Source

• object Extensible
  Represents a base extensible schema for TM Forum Open APIs. The entity must include @type.
• object Error-allOf[1]

{
    "allOf":[
        {
            "$ref":"#/components/schemas/Extensible"
        },
        {
            "type":"object",
            "required":[
                "code",
                "reason"
            ],
            "properties":{
                "code":{
                    "type":"string",
                    "description":"The application-specific error detail defined by the API or a common list."
                },
                "reason":{
                    "type":"string",
                    "description":"Explains the error to a client user."
                },
                "message":{
                    "type":"string",
                    "description":"Provides error details and corrective actions for a client user."
                },
                "status":{
                    "type":"string",
                    "description":"The HTTP error code extension."
                },
                "referenceError":{
                    "type":"string",
                    "description":"The URI of documentation that describes the error."
                }
            }
        }
    ],
    "description":"Represents an error returned by an API, typically with an HTTP 3xx, 4xx, or 5xx response code."
}

Nested Schema : Extensible

Type: object

Represents a base extensible schema for TM Forum Open APIs. The entity must include @type.

Show Source

• @baseType: string
  The superclass.
• @schemaLocation: string
  The URI of a JSON Schema file that defines additional attributes and relationships.
• @type(required): string
  The subclass Extensible name.

{
    "type":"object",
    "description":"Represents a base extensible schema for TM Forum Open APIs. The entity must include @type.",
    "properties":{
        "@type":{
            "type":"string",
            "nullable":true,
            "description":"The subclass Extensible name."
        },
        "@baseType":{
            "type":"string",
            "nullable":true,
            "description":"The superclass."
        },
        "@schemaLocation":{
            "type":"string",
            "nullable":true,
            "description":"The URI of a JSON Schema file that defines additional attributes and relationships."
        }
    },
    "required":[
        "@type"
    ]
}

Nested Schema : Error-allOf[1]

Type: object

Show Source

• code(required): string
  The application-specific error detail defined by the API or a common list.
• message: string
  Provides error details and corrective actions for a client user.
• reason(required): string
  Explains the error to a client user.
• referenceError: string
  The URI of documentation that describes the error.
• status: string
  The HTTP error code extension.

{
    "type":"object",
    "required":[
        "code",
        "reason"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"The application-specific error detail defined by the API or a common list."
        },
        "reason":{
            "type":"string",
            "description":"Explains the error to a client user."
        },
        "message":{
            "type":"string",
            "description":"Provides error details and corrective actions for a client user."
        },
        "status":{
            "type":"string",
            "description":"The HTTP error code extension."
        },
        "referenceError":{
            "type":"string",
            "description":"The URI of documentation that describes the error."
        }
    }
}

500 Response

The system encountered an internal error.

Body ()

Root Schema : Error

Represents an error returned by an API, typically with an HTTP 3xx, 4xx, or 5xx response code.

Match All

Represents an error returned by an API, typically with an HTTP 3xx, 4xx, or 5xx response code.

Represents an error returned by an API, typically with an HTTP 3xx, 4xx, or 5xx response code.

Show Source

• object Extensible
  Represents a base extensible schema for TM Forum Open APIs. The entity must include @type.
• object Error-allOf[1]

{
    "allOf":[
        {
            "$ref":"#/components/schemas/Extensible"
        },
        {
            "type":"object",
            "required":[
                "code",
                "reason"
            ],
            "properties":{
                "code":{
                    "type":"string",
                    "description":"The application-specific error detail defined by the API or a common list."
                },
                "reason":{
                    "type":"string",
                    "description":"Explains the error to a client user."
                },
                "message":{
                    "type":"string",
                    "description":"Provides error details and corrective actions for a client user."
                },
                "status":{
                    "type":"string",
                    "description":"The HTTP error code extension."
                },
                "referenceError":{
                    "type":"string",
                    "description":"The URI of documentation that describes the error."
                }
            }
        }
    ],
    "description":"Represents an error returned by an API, typically with an HTTP 3xx, 4xx, or 5xx response code."
}

Nested Schema : Extensible

Type: object

Represents a base extensible schema for TM Forum Open APIs. The entity must include @type.

Show Source

• @baseType: string
  The superclass.
• @schemaLocation: string
  The URI of a JSON Schema file that defines additional attributes and relationships.
• @type(required): string
  The subclass Extensible name.

{
    "type":"object",
    "description":"Represents a base extensible schema for TM Forum Open APIs. The entity must include @type.",
    "properties":{
        "@type":{
            "type":"string",
            "nullable":true,
            "description":"The subclass Extensible name."
        },
        "@baseType":{
            "type":"string",
            "nullable":true,
            "description":"The superclass."
        },
        "@schemaLocation":{
            "type":"string",
            "nullable":true,
            "description":"The URI of a JSON Schema file that defines additional attributes and relationships."
        }
    },
    "required":[
        "@type"
    ]
}

Nested Schema : Error-allOf[1]

Type: object

Show Source

• code(required): string
  The application-specific error detail defined by the API or a common list.
• message: string
  Provides error details and corrective actions for a client user.
• reason(required): string
  Explains the error to a client user.
• referenceError: string
  The URI of documentation that describes the error.
• status: string
  The HTTP error code extension.

{
    "type":"object",
    "required":[
        "code",
        "reason"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"The application-specific error detail defined by the API or a common list."
        },
        "reason":{
            "type":"string",
            "description":"Explains the error to a client user."
        },
        "message":{
            "type":"string",
            "description":"Provides error details and corrective actions for a client user."
        },
        "status":{
            "type":"string",
            "description":"The HTTP error code extension."
        },
        "referenceError":{
            "type":"string",
            "description":"The URI of documentation that describes the error."
        }
    }
}

Back to Top

Examples

The following examples show 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 first example uses query parameters to show a single accumulated balance object and only displays specific fields.

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

Response Body

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

[
  {
    "id": "0.0.0.1+-account+140598+840",
    "href": "http://host:port/brm/prepayBalanceManagement/version/accumulatedBalance/0.0.0.1+-account+140598+840",
    "bucket": [
      {
        "id": "0.0.0.1+-balance_group+141494+840+0",
        "href": "http://host:port/brm/prepayBalanceManagement/version/bucket/0.0.0.1+-balance_group+141494+840+0",
        "name": "Balance Group<Account>",
        "@baseType": "BucketRef",
        "@schemaLocation": null,
        "@type": "BucketRef",
        "@referredType": null
      }
    ],
    "partyAccount": {
      "id": "test_account_140598",
      "href": null,
      "description": null,
      "name": "Venkateswari Moorthy",
      "status": "active",
      "@baseType": "PartyAccountRef",
      "@schemaLocation": null,
      "@type": "PartyAccountRef",
      "@referredType": null
    },
    "product": [
      {
        "id": "0.0.0.1+-service-telco-gsm-telephony+143030",
        "href": null,
        "name": "ServiceTelcoGsmTelephony",
        "@baseType": "ProductRef",
        "@schemaLocation": null,
        "@type": "ProductRef",
        "@referredType": null
      }
    ],
    "totalBalance": {
      "amount": 176.21,
      "units": "USD",
      "@baseType": null,
      "@schemaLocation": null,
      "@type": "Quantity"
    }
  }
]

Get Accumulated Balances by External Account ID

The following example filters by the account's external ID. External ID searches require the custom mapper flag described in the release changes.

curl -X GET 'http://host:port/brm/prepayBalanceManagement/version/accumulatedBalance?@type=AccumulatedBalance&partyAccount.id=test_account_140598'

Response Body

[
  {
    "id": "0.0.0.1+-account+140598+840",
    "href": "http://host:port/brm/prepayBalanceManagement/version/accumulatedBalance/0.0.0.1+-account+140598+840",
    "description": "",
    "name": "Venkateswari Moorthy",
    "bucket": [
      {
        "id": "0.0.0.1+-balance_group+141494+840+0",
        "href": "http://host:port/brm/prepayBalanceManagement/version/bucket/0.0.0.1+-balance_group+141494+840+0",
        "name": "Balance Group<Account>",
        "@baseType": "BucketRef",
        "@schemaLocation": null,
        "@type": "BucketRef",
        "@referredType": null
      }
    ],
    "logicalResource": {
      "@baseType": "LogicalResourceRef",
      "@referredType": null,
      "@schemaLocation": null,
      "@type": "LogicalResourceRef",
      "href": null,
      "id": null,
      "name": null,
      "value": "472-20260410-072856-0-245742-906351744-cagbu-phx-1038"
    },
    "partyAccount": {
      "id": "test_account_140598",
      "href": null,
      "description": null,
      "name": "Venkateswari Moorthy",
      "status": "active",
      "@baseType": "PartyAccountRef",
      "@schemaLocation": null,
      "@type": "PartyAccountRef",
      "@referredType": null
    },
    "product": [
      {
        "id": "0.0.0.1+-service-telco-gsm-telephony+143030",
        "href": null,
        "name": "ServiceTelcoGsmTelephony",
        "@baseType": "ProductRef",
        "@schemaLocation": null,
        "@type": "ProductRef",
        "@referredType": null
      }
    ],
    "relatedParty": [],
    "totalBalance": {
      "amount": 176.21,
      "units": "USD",
      "@baseType": null,
      "@schemaLocation": null,
      "@type": "Quantity"
    },
    "@baseType": "AccumulatedBalance",
    "@schemaLocation": "",
    "@type": "AccumulatedBalance"
  }
]

Get Accumulated Balances by Bill Structure ID

The following example filters by billStructure.id. The response includes billStructure and sets billingCycleSpecification to null.

curl -X GET 'http://host:port/brm/prepayBalanceManagement/version/accumulatedBalance?@type=AccumulatedBalanceOracle&billStructure.id=test_bill_structure_174268'

Response Body

[
  {
    "id": "0.0.0.1+-account+173981+840",
    "href": "http://host:port/brm/prepayBalanceManagement/version/accumulatedBalance/0.0.0.1+-account+173981+840",
    "description": "",
    "name": "Rachel Douglas",
    "bucket": [
      {
        "id": "0.0.0.1+-balance_group+175837+840+0",
        "href": "http://host:port/brm/prepayBalanceManagement/version/bucket/0.0.0.1+-balance_group+175837+840+0",
        "name": "",
        "@baseType": "BucketRef",
        "@schemaLocation": null,
        "@type": "BucketRef",
        "@referredType": null
      }
    ],
    "logicalResource": {
      "@baseType": "LogicalResourceRef",
      "@referredType": null,
      "@schemaLocation": null,
      "@type": "LogicalResourceRef",
      "href": null,
      "id": null,
      "name": null,
      "value": ""
    },
    "partyAccount": {
      "id": "0.0.0.1+-account+173981",
      "href": null,
      "description": null,
      "name": "Rachel Douglas",
      "status": "active",
      "@baseType": "PartyAccountRef",
      "@schemaLocation": null,
      "@type": "PartyAccountRef",
      "@referredType": null
    },
    "product": [
      {
        "id": "0.0.0.1+-service-telco-gsm-telephony+247218",
        "href": null,
        "name": "ServiceTelcoGsmTelephony",
        "@baseType": "ProductRef",
        "@schemaLocation": null,
        "@type": "ProductRef",
        "@referredType": null
      }
    ],
    "relatedParty": [],
    "totalBalance": {
      "amount": 270.0,
      "units": "USD",
      "@baseType": null,
      "@schemaLocation": null,
      "@type": "Quantity"
    },
    "@baseType": "AccumulatedBalance",
    "@schemaLocation": "",
    "@type": "AccumulatedBalanceOracle",
    "billingCycleSpecification": null,
    "billStructure": {
      "id": "test_bill_structure_174268",
      "href": "http://host:port/brm/accountManagement/v5/billingAccount?billStructure.id=test_bill_structure_174268",
      "name": "Default BillStructure"
    },
    "unbilledBalance": {
      "amount": 270.0,
      "units": "USD",
      "@baseType": null,
      "@schemaLocation": null,
      "@type": "Quantity"
    },
    "originalBalance": {
      "amount": null,
      "units": null,
      "@baseType": null,
      "@schemaLocation": null,
      "@type": "Quantity"
    }
  }
]

Get Accumulated Balances by Service Alias

The following example shows the request and response for this filter.

curl -X GET 'http://host:port/brm/prepayBalanceManagement/version/accumulatedBalance?@type=AccumulatedBalanceOracle&product.id=aliasIMEIBase_0010'

Response Body

[
  {
    "id": "0.0.0.1+-account+173981+840",
    "href": "http://host:port/brm/prepayBalanceManagement/version/accumulatedBalance/0.0.0.1+-account+173981+840",
    "description": "",
    "name": "Rachel Douglas",
    "bucket": [
      {
        "id": "0.0.0.1+-balance_group+175837+840+0",
        "href": "http://host:port/brm/prepayBalanceManagement/version/bucket/0.0.0.1+-balance_group+175837+840+0",
        "name": "",
        "@baseType": "BucketRef",
        "@schemaLocation": null,
        "@type": "BucketRef",
        "@referredType": null
      }
    ],
    "logicalResource": {
      "@baseType": "LogicalResourceRef",
      "@referredType": null,
      "@schemaLocation": null,
      "@type": "LogicalResourceRef",
      "href": null,
      "id": null,
      "name": null,
      "value": ""
    },
    "partyAccount": {
      "id": "0.0.0.1+-account+173981",
      "href": null,
      "description": null,
      "name": "Rachel Douglas",
      "status": "active",
      "@baseType": "PartyAccountRef",
      "@schemaLocation": null,
      "@type": "PartyAccountRef",
      "@referredType": null
    },
    "product": [
      {
        "id": "aliasIMEIBase_0010",
        "href": null,
        "name": "ServiceTelcoGsmTelephony",
        "@baseType": "ProductRef",
        "@schemaLocation": null,
        "@type": "ProductRef",
        "@referredType": null
      }
    ],
    "relatedParty": [],
    "totalBalance": {
      "amount": 260.0,
      "units": "USD",
      "@baseType": null,
      "@schemaLocation": null,
      "@type": "Quantity"
    },
    "@baseType": "AccumulatedBalance",
    "@schemaLocation": "",
    "@type": "AccumulatedBalanceOracle",
    "billingCycleSpecification": [
      {
        "id": "0.0.0.1+-billinfo+174685",
        "href": "http://host:port/brm/accountManagement/v4/billingCycleSpecification/0.0.0.1+-billinfo+174685",
        "name": null
      }
    ],
    "unbilledBalance": {
      "amount": 260.0,
      "units": "USD",
      "@baseType": null,
      "@schemaLocation": null,
      "@type": "Quantity"
    },
    "originalBalance": {
      "amount": null,
      "units": null,
      "@baseType": null,
      "@schemaLocation": null,
      "@type": "Quantity"
    }
  }
]

Back to Top