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

Get a Disputed Balance by ID

get

/disputeBalance/{id}

Gets the specified disputed balance.

Request

Path Parameters
  • The item dispute ID or item dispute number.
    Examples

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

There's no request body for this operation.

Back to Top

Response

Supported Media Types

200 Response

The disputed balance was retrieved successfully.
Body ()
Root Schema : Dispute Balance Oracle
Type: object
Title: Dispute Balance Oracle
A disputed balance, extended for BRM REST Services Manager.
Show Source
Nested Schema : Quantity
Type: object
The amount in a given unit.
Show Source
Nested Schema : Bill Ref
Type: object
Title: Bill Ref
A reference to a bill.
Show Source
Nested Schema : billEvent
Type: array
Events associated with the dispute.
Show Source
Nested Schema : Billing Cycle Specification Ref Oracle
Type: object
Title: Billing Cycle Specification Ref Oracle
A reference to a billing cycle specification, extended for BRM REST Services Manager.
Show Source
Nested Schema : billItem
Type: array
The bill items associated with the dispute.
Show Source
Nested Schema : Party Account Ref
Type: object
Title: Party Account Ref
A reference to a party account.
Show Source
Nested Schema : BillEvent Dispute Oracle
Type: object
Title: BillEvent Dispute Oracle
A disputed bill event.
Show Source
Nested Schema : Money
Type: object
The base / value business entity used to represent money.
Show Source
  • The currency (ISO4217 norm uses 3 letters to define the currency).
  • The signed floating point number, the meaning of the sign is according to the context of the API that uses this Data type
Nested Schema : BillItem Dispute Oracle
Type: object
Title: BillItem Dispute Oracle
A disputed bill item (AppliedCustomerBillingRate).
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 example shows how to get a disputed balance with a specified ID by submitting a GET request on the REST resource using cURL. For more information about cURL, see Use cURL.

This request uses the id path parameter set to an item dispute number, but you can also set it to an item dispute POID. 

curl -X GET 'http://host:port/brm/prepayBalanceManagement/version/disputeBalance/D1-85'

Example of the Response Body

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

{
   "id": "0.0.0.1+-item-dispute+57743",
   "href": "http://host:port/brm/prepayBalanceManagement/version/disputeBalance/0.0.0.1+-item-dispute+57743",
   "actionType": "ItemDispute",
   "disputeNo": "D1-85",
   "amount": {
      "amount": -2.0,
      "units": "USD",
      "@baseType": null,
      "@schemaLocation": null,
      "@type": null
   },
   "taxAmount": null,
   "reason": "0",
   "description": "",
   "partyAccount": {
      "id": "0.0.0.1+-account+53871",
      "href": null,
      "description": null,
      "name": "Karl V",
      "status": null,
      "@baseType": null,
      "@schemaLocation": null,
      "@type": null,
      "@referredType": null
   },
   "discount": "0",
   "taxTreatment": "TaxExcluded",
   "confirmationDate": "2025-06-25T06:56:29-07:00",
   "requestedDate": "2025-06-25T06:56:29-07:00",
   "billingCycleSpecification": {
      "id": "0.0.0.1+-billinfo+56943",
      "href": "http://host:port/brm/accountManagement/version/billingCycleSpecification/0.0.0.1+-billinfo+56943",
      "name": "Bill Unit(1)"
   },
   "bill": {
      "id": "0.0.0.1+-bill+51039",
      "href": "http://host:port/brm/customerBillManagement/version/customerBill/0.0.0.1+-bill+51039",
      "@baseType": null,
      "@schemaLocation": null,
      "@type": "BillRef",
      "@referredType": "CustomerBill"
   },
   "billItem": [
      {
         "id": "0.0.0.1+-item-cycle_forward+54511",
         "href": "http://host:port/brm/customerBillManagement/version/appliedCustomerBillingRate/0.0.0.1+-item-cycle_forward+54511",
         "name": "Cycle forward",
         "originalCharge": {
            "unit": "USD",
            "value": 10.0
         },
         "disputeAmount": {
            "unit": "USD",
            "value": -2.0
         }
      }
   ],
   "billEvent": null,
   "status": "Settled",
   "settlementId": "0.0.0.1+-item-settlement+60077",
   "@baseType": "DisputeBalanceOracle",
   "@schemaLocation": null,
   "@type": "DisputeBalanceOracle"
}
Back to Top