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.Example:
AccumulatedBalance
-
fields: string
The list of comma-separated fields to return in the response.Example:
totalBalance,bucket
-
id: string
Returns the accumulated balances for the account with the specified ID.Example:
0.0.0.1+-account+102879
-
limit: integer
The maximum number of results to return. For example, use limit=10 to return the first 10 results only.Example:
10
-
offset: integer
The number of results to offset the response by. For example, use offset=10 to return results 10 and higher.Example:
10
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json;charset=utf-8
200 Response
Success
Headers
-
X-Result-Count(required):
The number of items returned in the response body.
-
X-Total-Count(required):
The total number of items that matched the criteria.
Root Schema : schema
Type:
Show Source
array
-
Array of:
object Accumulated Balance
Title:
Accumulated Balance
An amount owed by an account, aggregating amounts contained in a set of buckets.
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
-
@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. (BRM does not use this property.) -
@type: string
Title:
Type
The object's subclass. -
bucket(required): array
array
bucket
Minimum Number of Items:
1
The buckets containing the accumulated balance. -
description: string
Title:
description
The accumulated balance's description. (BRM does not use this property.) -
href: string
Title:
Href
The accumulated balance's href. (BRM does not use this property.) -
id(required): string
Title:
ID
The accumulated balance's ID. -
logicalResource: array
array
logicalResource
The logical resource associated with the accumulated balance.
-
name(required): string
Title:
Name
The accumulated balance's name. -
partyAccount: object
object
Party Account Ref
Title:
Party Account Ref
A reference to a party account. -
product: array
array
product
Products associated with the accumulated balance.
- relatedParty: array array relatedParty
-
totalBalance(required): object
object
Quantity
Title:
Quantity
The quantity of an object.
Nested Schema : bucket
Type:
array
Minimum Number of Items:
1
The buckets containing the accumulated balance.
Show Source
-
Array of:
object Bucket Ref
Title:
Bucket Ref
A reference to a bucket.
Nested Schema : logicalResource
Type:
array
The logical resource associated with the accumulated balance.
Show Source
-
Array of:
object Logical Resource Ref
Title:
Logical Resource Ref
A reference to a logical resource.
Nested Schema : Party Account Ref
Type:
object
Title:
Party Account Ref
A reference to a party account.
Show Source
-
@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.
Nested Schema : product
Type:
array
Products associated with the accumulated balance.
Show Source
-
Array of:
object Product Ref
Title:
Product Ref
A reference to a product.
Nested Schema : Quantity
Type:
object
Title:
Quantity
The quantity of an object.
Show Source
-
amount: number
(float)
Title:
Amount
Default Value:1
A numeric value. -
units: string
Title:
Units
A unit. For example, MB or minutes.
Nested Schema : Bucket Ref
Type:
object
Title:
Bucket Ref
A reference to a bucket.
Show Source
-
@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
(uri)
The bucket's href.
-
id(required): string
Title:
Bucket ID
The bucket's ID. -
name: string
Title:
Bucket Name
The bucket's name. -
usageType: string
The bucket's usage type.
Nested Schema : Logical Resource Ref
Type:
object
Title:
Logical Resource Ref
A reference to a logical resource.
Show Source
-
@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. -
value: string
The resource's value.
Nested Schema : Product Ref
Type:
object
Title:
Product Ref
A reference to a product.
Show Source
-
@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.
Nested Schema : Related Party
Type:
object
Title:
Related Party
A party related to another object.
Show Source
-
@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
(uri)
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.
400 Response
Bad Request
Root Schema : Error
Type:
object
Title:
Error
Used when an API returns an error, typically with a HTTP error response-code such as 401 (Unauthorized) or 500 (Internal Server Error).
Show Source
-
@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. -
code(required): string
Title:
Error Code
An error code. -
message: string
Title:
Error Message
Details and corrective actions related to the error. -
reason(required): string
Title:
Reason
The reason for the error. -
referenceError: string
(uri)
Title:
Reference Error
A URI to documentation describing the error. -
status: string
Title:
Error Status
The HTTP Error code extension.
401 Response
Unauthorized
Root Schema : Error
Type:
object
Title:
Error
Used when an API returns an error, typically with a HTTP error response-code such as 401 (Unauthorized) or 500 (Internal Server Error).
Show Source
-
@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. -
code(required): string
Title:
Error Code
An error code. -
message: string
Title:
Error Message
Details and corrective actions related to the error. -
reason(required): string
Title:
Reason
The reason for the error. -
referenceError: string
(uri)
Title:
Reference Error
A URI to documentation describing the error. -
status: string
Title:
Error Status
The HTTP Error code extension.
403 Response
Forbidden
Root Schema : Error
Type:
object
Title:
Error
Used when an API returns an error, typically with a HTTP error response-code such as 401 (Unauthorized) or 500 (Internal Server Error).
Show Source
-
@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. -
code(required): string
Title:
Error Code
An error code. -
message: string
Title:
Error Message
Details and corrective actions related to the error. -
reason(required): string
Title:
Reason
The reason for the error. -
referenceError: string
(uri)
Title:
Reference Error
A URI to documentation describing the error. -
status: string
Title:
Error Status
The HTTP Error code extension.
404 Response
Not Found
Root Schema : Error
Type:
object
Title:
Error
Used when an API returns an error, typically with a HTTP error response-code such as 401 (Unauthorized) or 500 (Internal Server Error).
Show Source
-
@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. -
code(required): string
Title:
Error Code
An error code. -
message: string
Title:
Error Message
Details and corrective actions related to the error. -
reason(required): string
Title:
Reason
The reason for the error. -
referenceError: string
(uri)
Title:
Reference Error
A URI to documentation describing the error. -
status: string
Title:
Error Status
The HTTP Error code extension.
405 Response
Method Not Allowed
Root Schema : Error
Type:
object
Title:
Error
Used when an API returns an error, typically with a HTTP error response-code such as 401 (Unauthorized) or 500 (Internal Server Error).
Show Source
-
@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. -
code(required): string
Title:
Error Code
An error code. -
message: string
Title:
Error Message
Details and corrective actions related to the error. -
reason(required): string
Title:
Reason
The reason for the error. -
referenceError: string
(uri)
Title:
Reference Error
A URI to documentation describing the error. -
status: string
Title:
Error Status
The HTTP Error code extension.
409 Response
Conflict
Root Schema : Error
Type:
object
Title:
Error
Used when an API returns an error, typically with a HTTP error response-code such as 401 (Unauthorized) or 500 (Internal Server Error).
Show Source
-
@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. -
code(required): string
Title:
Error Code
An error code. -
message: string
Title:
Error Message
Details and corrective actions related to the error. -
reason(required): string
Title:
Reason
The reason for the error. -
referenceError: string
(uri)
Title:
Reference Error
A URI to documentation describing the error. -
status: string
Title:
Error Status
The HTTP Error code extension.
500 Response
Internal Server Error
Root Schema : Error
Type:
object
Title:
Error
Used when an API returns an error, typically with a HTTP error response-code such as 401 (Unauthorized) or 500 (Internal Server Error).
Show Source
-
@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. -
code(required): string
Title:
Error Code
An error code. -
message: string
Title:
Error Message
Details and corrective actions related to the error. -
reason(required): string
Title:
Reason
The reason for the error. -
referenceError: string
(uri)
Title:
Reference Error
A URI to documentation describing the error. -
status: string
Title:
Error Status
The HTTP Error code extension.
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 } ]