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:
object
Title:
Dispute Balance Oracle
A disputed balance, extended for BRM REST Services Manager.
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. -
actionType: string
Title:
Action Type
Allowed 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 Ref
A 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 Oracle
A 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 Date
The date the dispute was confirmed. -
description: string
Title:
Dispute Description
The dispute's description. -
discount: string
Title:
Discount
A discount associated with the dispute. -
disputeNo: string
Title:
Dispute Number
The dispute number to displayed on a bill. -
href(required): string
Title:
Href
The disputed balance's href. -
id(required): string
Title:
Dispute ID
The disputed balance's ID. -
partyAccount: object
Party Account Ref
Title:
Party Account Ref
A reference to a party account. -
reason: string
Title:
Dispute Reason
The reason for the dispute. -
requestedDate: string
(date-time)
Title:
Requested Date
The date the request was made. -
settlementId: string
Title:
Settlement ID
The ID of the settlement associated with the dispute. -
status: string
Title:
Status
Allowed Values:[ "Settled", "Open" ]
The dispute's status. -
taxAmount: object
Quantity
An amount in a given unit.
-
taxTreatment: string
Title:
Tax Treatment
Allowed Values:[ "TaxIncluded", "TaxExcluded", "TaxOnly" ]
The status of taxes on the dispute.
Nested Schema : Quantity
Type:
object
An amount in a given unit.
Show Source
-
amount: number
(float)
Default Value:
1
Numeric value in a given unit. -
units: string
Unit
Nested Schema : Bill Ref
Type:
object
Title:
Bill Ref
A reference to a bill.
Show Source
-
@baseType: string
Title:
Base Type
The object's superclass. -
@referredType: string
Title:
Referred Type
The actual type of the target instance when needed for 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(required): string
Title:
Bill Href
The bill's href. -
id(required): string
Title:
Bill ID
The bill's ID.
Nested Schema : billEvent
Type:
array
Events associated with the dispute.
Show Source
-
Array of:
object BillEvent Dispute Oracle
Title:
BillEvent Dispute Oracle
A disputed bill event.
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
-
href: string
Title:
Href
The billing cycle specification's href. -
id: string
Title:
ID
The billing cycle specification's ID. -
name: string
Title:
Name
The billing cycle specification's name.
Nested Schema : billItem
Type:
array
The bill items associated with the dispute.
Show Source
-
Array of:
object BillItem Dispute Oracle
Title:
BillItem Dispute Oracle
A disputed bill item (AppliedCustomerBillingRate).
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 : BillEvent Dispute Oracle
Type:
object
Title:
BillEvent Dispute Oracle
A disputed bill event.
Show Source
-
adjustmentAmount: object
Money
A base / value business entity used to represent money.
-
href: string
Title:
Href
The disputed event's href. -
id: string
Title:
Id
The disputed event's ID. -
name: string
Title:
Name
The disputed event's name. -
originalCharge: object
Money
A base / value business entity used to represent money.
Nested Schema : Money
Type:
object
A base / value business entity used to represent money.
Show Source
-
unit(required): string
Refers to the currency (ISO4217 norm uses 3 letters to define the currency).
-
value(required): number
(float)
A positive floating point number.
Nested Schema : BillItem Dispute Oracle
Type:
object
Title:
BillItem Dispute Oracle
A disputed bill item (AppliedCustomerBillingRate).
Show Source
-
adjustmentAmount: object
Money
A base / value business entity used to represent money.
-
href(required): string
Title:
Href
The disputed item's href. -
id(required): string
Title:
Id
The disputed item's ID. -
name(required): string
Title:
Name
The disputed item's name. -
originalCharge: object
Money
A base / value business entity used to represent money.
400 Response
Bad Request
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
-
@baseType: string
This defines the super-class when sub-classing.
-
@schemaLocation: string
(uri)
A URI to a JSON-schema file that defines additional attributes and relationships.
-
@type: string
This defines the sub-class entity name when sub-classing.
-
code(required): string
Refers to application relevant detail, defined in the API or a common list.
-
message: string
More details and corrective actions related to the error which can be shown to a client user.
-
reason(required): string
Explanation of the reason for the error which can be shown to a client user.
-
referenceError: string
(uri)
URI of documentation describing the error.
-
status: string
Displays the HTTP error code extension.
401 Response
Unauthorized
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
-
@baseType: string
This defines the super-class when sub-classing.
-
@schemaLocation: string
(uri)
A URI to a JSON-schema file that defines additional attributes and relationships.
-
@type: string
This defines the sub-class entity name when sub-classing.
-
code(required): string
Refers to application relevant detail, defined in the API or a common list.
-
message: string
More details and corrective actions related to the error which can be shown to a client user.
-
reason(required): string
Explanation of the reason for the error which can be shown to a client user.
-
referenceError: string
(uri)
URI of documentation describing the error.
-
status: string
Displays the HTTP error code extension.
403 Response
Forbidden
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
-
@baseType: string
This defines the super-class when sub-classing.
-
@schemaLocation: string
(uri)
A URI to a JSON-schema file that defines additional attributes and relationships.
-
@type: string
This defines the sub-class entity name when sub-classing.
-
code(required): string
Refers to application relevant detail, defined in the API or a common list.
-
message: string
More details and corrective actions related to the error which can be shown to a client user.
-
reason(required): string
Explanation of the reason for the error which can be shown to a client user.
-
referenceError: string
(uri)
URI of documentation describing the error.
-
status: string
Displays the HTTP error code extension.
404 Response
Not Found
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
-
@baseType: string
This defines the super-class when sub-classing.
-
@schemaLocation: string
(uri)
A URI to a JSON-schema file that defines additional attributes and relationships.
-
@type: string
This defines the sub-class entity name when sub-classing.
-
code(required): string
Refers to application relevant detail, defined in the API or a common list.
-
message: string
More details and corrective actions related to the error which can be shown to a client user.
-
reason(required): string
Explanation of the reason for the error which can be shown to a client user.
-
referenceError: string
(uri)
URI of documentation describing the error.
-
status: string
Displays the HTTP error code extension.
405 Response
Method Not allowed
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
-
@baseType: string
This defines the super-class when sub-classing.
-
@schemaLocation: string
(uri)
A URI to a JSON-schema file that defines additional attributes and relationships.
-
@type: string
This defines the sub-class entity name when sub-classing.
-
code(required): string
Refers to application relevant detail, defined in the API or a common list.
-
message: string
More details and corrective actions related to the error which can be shown to a client user.
-
reason(required): string
Explanation of the reason for the error which can be shown to a client user.
-
referenceError: string
(uri)
URI of documentation describing the error.
-
status: string
Displays the HTTP error code extension.
409 Response
Conflict
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
-
@baseType: string
This defines the super-class when sub-classing.
-
@schemaLocation: string
(uri)
A URI to a JSON-schema file that defines additional attributes and relationships.
-
@type: string
This defines the sub-class entity name when sub-classing.
-
code(required): string
Refers to application relevant detail, defined in the API or a common list.
-
message: string
More details and corrective actions related to the error which can be shown to a client user.
-
reason(required): string
Explanation of the reason for the error which can be shown to a client user.
-
referenceError: string
(uri)
URI of documentation describing the error.
-
status: string
Displays the HTTP error code extension.
500 Response
Internal Server Error
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
-
@baseType: string
This defines the super-class when sub-classing.
-
@schemaLocation: string
(uri)
A URI to a JSON-schema file that defines additional attributes and relationships.
-
@type: string
This defines the sub-class entity name when sub-classing.
-
code(required): string
Refers to application relevant detail, defined in the API or a common list.
-
message: string
More details and corrective actions related to the error which can be shown to a client user.
-
reason(required): string
Explanation of the reason for the error which can be shown to a client user.
-
referenceError: string
(uri)
URI of documentation describing the error.
-
status: string
Displays the 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": "2020-06-25T06:56:29-07:00", "requestedDate": "2020-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" }