Get a Disputed Balance by ID
get
/disputeBalance/{id}
Gets the specified disputed balance.
Request
Path Parameters
-
id(required): string
The ID of the disputed balance.Example:
0.0.0.1+-item-dispute+209114
Query Parameters
-
@type: string
The type of object to return.Example:
Use @type=DisputeBalance for a base object or @type=DisputeBalanceOracle for an extended object. -
fields: string
The list of comma-separated fields to return in the response.Example:
fields=amount,billItem
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json;charset=utf-8
200 Response
Success
Root Schema : Dispute Balance Oracle
Type:
objectTitle:
Dispute Balance OracleA disputed balance, extended for BRM REST Services Manager.
Show Source
-
@baseType: string
Title:
Base TypeThe object's superclass. -
@schemaLocation: string
(uri)
Title:
Schema LocationA URI to a JSON-Schema file that defines additional attributes and relationships. -
@type: string
Title:
TypeThe object's subclass. -
actionType: string
Title:
Action TypeAllowed Values:[ "BillDispute", "ItemDispute", "EventDispute" ]The type of balance being disputed. -
amount: object
Quantity
An amount in a given unit.
-
bill(required): object
Bill Ref
Title:
Bill RefA reference to a bill. -
billEvent: array
billEvent
Events associated with the dispute.
-
billingCycleSpecification(required): object
Billing Cycle Specification Ref Oracle
Title:
Billing Cycle Specification Ref OracleA reference to a billing cycle specification, extended for BRM REST Services Manager. -
billItem: array
billItem
The bill items associated with the dispute.
-
confirmationDate: string
(date-time)
Title:
Confirmation DateThe date the dispute was confirmed. -
description: string
Title:
Dispute DescriptionThe dispute's description. -
discount: string
Title:
DiscountA discount associated with the dispute. -
disputeNo: string
Title:
Dispute NumberThe dispute number to displayed on a bill. -
href(required): string
Title:
HrefThe disputed balance's href. -
id(required): string
Title:
Dispute IDThe disputed balance's ID. -
partyAccount: object
Party Account Ref
Title:
Party Account RefA reference to a party account. -
reason: string
Title:
Dispute ReasonThe reason for the dispute. -
requestedDate: string
(date-time)
Title:
Requested DateThe date the request was made. -
settlementId: string
Title:
Settlement IDThe ID of the settlement associated with the dispute. -
status: string
Title:
StatusAllowed Values:[ "Settled", "Open" ]The dispute's status. -
taxAmount: object
Quantity
An amount in a given unit.
-
taxTreatment: string
Title:
Tax TreatmentAllowed Values:[ "TaxIncluded", "TaxExcluded", "TaxOnly" ]The status of taxes on the dispute.
Nested Schema : Quantity
Type:
objectAn amount in a given unit.
Show Source
-
amount: number
(float)
Default Value:
1Numeric value in a given unit. -
units: string
Unit
Nested Schema : Bill Ref
Type:
objectTitle:
Bill RefA reference to a bill.
Show Source
-
@baseType: string
Title:
Base TypeThe object's superclass. -
@referredType: string
Title:
Referred TypeThe actual type of the target instance when needed for disambiguation. -
@schemaLocation: string
(uri)
Title:
Schema LocationA URI to a JSON-Schema file that defines additional attributes and relationships -
@type: string
Title:
TypeThe object's subclass. -
href(required): string
Title:
Bill HrefThe bill's href. -
id(required): string
Title:
Bill IDThe bill's ID.
Nested Schema : billEvent
Type:
arrayEvents associated with the dispute.
Show Source
-
Array of:
object BillEvent Dispute Oracle
Title:
BillEvent Dispute OracleA disputed bill event.
Nested Schema : Billing Cycle Specification Ref Oracle
Type:
objectTitle:
Billing Cycle Specification Ref OracleA reference to a billing cycle specification, extended for BRM REST Services Manager.
Show Source
-
href: string
Title:
HrefThe billing cycle specification's href. -
id: string
Title:
IDThe billing cycle specification's ID. -
name: string
Title:
NameThe billing cycle specification's name.
Nested Schema : billItem
Type:
arrayThe bill items associated with the dispute.
Show Source
-
Array of:
object BillItem Dispute Oracle
Title:
BillItem Dispute OracleA disputed bill item (AppliedCustomerBillingRate).
Nested Schema : Party Account Ref
Type:
objectTitle:
Party Account RefA reference to a party account.
Show Source
-
@baseType: string
Title:
Base TypeThe object's superclass. -
@referredType: string
Title:
Referred TypeThe object's type in the target system, if baseType and type need further disambiguation. -
@schemaLocation: string
(uri)
Title:
Schema LocationA URI to a JSON-Schema file that defines additional attributes and relationships. -
@type: string
Title:
TypeThe object's subclass. -
description: string
Title:
DescriptionThe party account's description. -
href: string
Title:
HrefThe party account's href. -
id(required): string
Title:
Account IDThe party account's ID. -
name: string
Title:
NameThe party account's name. -
status: string
Title:
StatusThe overall status of the account. For example, due, paid, or in arrears.
Nested Schema : BillEvent Dispute Oracle
Type:
objectTitle:
BillEvent Dispute OracleA disputed bill event.
Show Source
-
adjustmentAmount: object
Money
Title:
MoneyAn amount of money. -
href: string
Title:
HrefThe disputed event's href. -
id: string
Title:
IdThe disputed event's ID. -
name: string
Title:
NameThe disputed event's name. -
originalCharge: object
Money
Title:
MoneyAn amount of money.
Nested Schema : Money
Type:
objectTitle:
MoneyAn amount of money.
Show Source
-
unit: string
Title:
CurrencyAn ISO 4217 three letter currency code. -
value: number
(float)
Title:
AmountA positive floating point number.
Nested Schema : BillItem Dispute Oracle
Type:
objectTitle:
BillItem Dispute OracleA disputed bill item (AppliedCustomerBillingRate).
Show Source
-
adjustmentAmount: object
Money
Title:
MoneyAn amount of money. -
href(required): string
Title:
HrefThe disputed item's href. -
id(required): string
Title:
IdThe disputed item's ID. -
name(required): string
Title:
NameThe disputed item's name. -
originalCharge: object
Money
Title:
MoneyAn amount of money.
400 Response
Bad Request
Root Schema : Error
Type:
objectTitle:
ErrorUsed 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 TypeThe object's superclass. -
@schemaLocation: string
(uri)
Title:
Schema LocationA URI to a JSON schema file that defines additional attributes and relationships. -
@type: string
Title:
TypeThe object's subclass. -
code(required): string
Title:
Error CodeAn application's error code, defined in the API or a common list. -
message: string
Title:
Error MessageMore details and corrective actions related to the error. -
reason(required): string
Title:
ReasonThe reason for the error. -
referenceError: string
(uri)
Title:
Reference ErrorA URI to documentation describing the error. -
status: string
Title:
Error StatusThe HTTP Error code extension
401 Response
Unauthorized
Root Schema : Error
Type:
objectTitle:
ErrorUsed 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 TypeThe object's superclass. -
@schemaLocation: string
(uri)
Title:
Schema LocationA URI to a JSON schema file that defines additional attributes and relationships. -
@type: string
Title:
TypeThe object's subclass. -
code(required): string
Title:
Error CodeAn application's error code, defined in the API or a common list. -
message: string
Title:
Error MessageMore details and corrective actions related to the error. -
reason(required): string
Title:
ReasonThe reason for the error. -
referenceError: string
(uri)
Title:
Reference ErrorA URI to documentation describing the error. -
status: string
Title:
Error StatusThe HTTP Error code extension
403 Response
Forbidden
Root Schema : Error
Type:
objectTitle:
ErrorUsed 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 TypeThe object's superclass. -
@schemaLocation: string
(uri)
Title:
Schema LocationA URI to a JSON schema file that defines additional attributes and relationships. -
@type: string
Title:
TypeThe object's subclass. -
code(required): string
Title:
Error CodeAn application's error code, defined in the API or a common list. -
message: string
Title:
Error MessageMore details and corrective actions related to the error. -
reason(required): string
Title:
ReasonThe reason for the error. -
referenceError: string
(uri)
Title:
Reference ErrorA URI to documentation describing the error. -
status: string
Title:
Error StatusThe HTTP Error code extension
404 Response
Not Found
Root Schema : Error
Type:
objectTitle:
ErrorUsed 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 TypeThe object's superclass. -
@schemaLocation: string
(uri)
Title:
Schema LocationA URI to a JSON schema file that defines additional attributes and relationships. -
@type: string
Title:
TypeThe object's subclass. -
code(required): string
Title:
Error CodeAn application's error code, defined in the API or a common list. -
message: string
Title:
Error MessageMore details and corrective actions related to the error. -
reason(required): string
Title:
ReasonThe reason for the error. -
referenceError: string
(uri)
Title:
Reference ErrorA URI to documentation describing the error. -
status: string
Title:
Error StatusThe HTTP Error code extension
405 Response
Method Not allowed
Root Schema : Error
Type:
objectTitle:
ErrorUsed 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 TypeThe object's superclass. -
@schemaLocation: string
(uri)
Title:
Schema LocationA URI to a JSON schema file that defines additional attributes and relationships. -
@type: string
Title:
TypeThe object's subclass. -
code(required): string
Title:
Error CodeAn application's error code, defined in the API or a common list. -
message: string
Title:
Error MessageMore details and corrective actions related to the error. -
reason(required): string
Title:
ReasonThe reason for the error. -
referenceError: string
(uri)
Title:
Reference ErrorA URI to documentation describing the error. -
status: string
Title:
Error StatusThe HTTP Error code extension
409 Response
Conflict
Root Schema : Error
Type:
objectTitle:
ErrorUsed 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 TypeThe object's superclass. -
@schemaLocation: string
(uri)
Title:
Schema LocationA URI to a JSON schema file that defines additional attributes and relationships. -
@type: string
Title:
TypeThe object's subclass. -
code(required): string
Title:
Error CodeAn application's error code, defined in the API or a common list. -
message: string
Title:
Error MessageMore details and corrective actions related to the error. -
reason(required): string
Title:
ReasonThe reason for the error. -
referenceError: string
(uri)
Title:
Reference ErrorA URI to documentation describing the error. -
status: string
Title:
Error StatusThe HTTP Error code extension
500 Response
Internal Server Error
Root Schema : Error
Type:
objectTitle:
ErrorUsed 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 TypeThe object's superclass. -
@schemaLocation: string
(uri)
Title:
Schema LocationA URI to a JSON schema file that defines additional attributes and relationships. -
@type: string
Title:
TypeThe object's subclass. -
code(required): string
Title:
Error CodeAn application's error code, defined in the API or a common list. -
message: string
Title:
Error MessageMore details and corrective actions related to the error. -
reason(required): string
Title:
ReasonThe reason for the error. -
referenceError: string
(uri)
Title:
Reference ErrorA URI to documentation describing the error. -
status: string
Title:
Error StatusThe HTTP Error code extension
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.
curl -X GET 'http://host:port/brm/prepayBalanceManagement/version/disputeBalance/0.0.0.1+-item-dispute+57743'
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-32",
"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"
}