Get Disputed Balances
get
/disputeBalance
Gets the disputed balances that match the specified query criteria.
Request
Query Parameters
-
@type: string
The type of object to return. Use @type=DisputeBalance for a base object or @type=DisputeBalanceOracle for an extended object.Example:
DisputeBalance
-
bill.id: string
Retrieves disputes for the bill with the specified ID or bill number.Example:
0.0.0.1+-bill+105773
-
billEvent.id: string
Retrieves disputes for the specified bill event.Example:
0.0.0.1+-event-billing-product-fee-cycle-cycle_forward_monthly+323397156054607117
-
billItem.id: string
Retrieves disputes for the bill item with the specified ID or bill item number.Example:
0.0.0.1+-item-cycle_forward+108813
-
billingCycleSpecification.id: string
Retrieves disputes for the billing cycle specification with the specified ID.Example:
0.0.0.1+-billinfo+107765
-
confirmationDate: string
Retrieve disputes with a confirmationDate that is equal to the specified date and time.Example:
2020-01-01T12:00:27.000Z
-
confirmationDate.gt: string
Retrieves disputes with a confirmationDate that is greater than the specified date and time.Example:
2020-01-01T12:00:27.000Z
-
confirmationDate.gte: string
Retrieves disputes with a confirmationDate that is greater than or equal to the specified date and time.Example:
2020-01-01T12:00:27.000Z
-
confirmationDate.lt: string
Retrieves disputes with a confirmationDate that is less than the specified date and time.Example:
2020-01-01T12:00:27.000Z
-
confirmationDate.lte: string
Retrieves disputes with a confirmationDate that is less than or equal to the specified date and time.Example:
2020-01-01T12:00:27.000Z
-
fields: string
The list of comma-separated fields to return in the response.Example:
amount,billItem
-
id: string
Retrieves the dispute with the specified ID or dispute number.Example:
0.0.0.1+-item-dispute+209114
-
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
-
requestedDate: string
Retrieves disputes with a requestedDate that is equal to the specified date and time.Example:
2020-01-01T12:00:27.000Z
-
requestedDate.gt: string
Retrieves disputes with a requestedDate that is greater than the specified date and time.Example:
2020-01-01T12:00:27.000Z
-
requestedDate.gte: string
Retrieves disputes with a requestedDate that is greater than or equal to the specified date and time.Example:
2020-01-01T12:00:27.000Z
-
requestedDate.lt: string
Retrieves disputes with a requestedDate that is less than the specified date and time.Example:
2020-01-01T12:00:27.000Z
-
requestedDate.lte: string
Retrieves disputes with a requestedDate that is less than or equal to the specified date and time.Example:
2020-01-01T12:00:27.000Z
-
status: string
Retrieves disputes by status.Example:
Open
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 Dispute Balance Oracle
Title:
Dispute Balance Oracle
A disputed balance, extended for BRM REST Services Manager.
Nested 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
object
Quantity
Title:
Quantity
The quantity of an object. -
bill(required): object
object
Bill Ref
Title:
Bill Ref
A reference to a bill. -
billEvent: array
array
billEvent
Events associated with the dispute.
-
billingCycleSpecification(required): object
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
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
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
object
Quantity
Title:
Quantity
The quantity of an object. -
taxTreatment: string
Title:
Tax Treatment
Allowed Values:[ "TaxIncluded", "TaxExcluded", "TaxOnly" ]
The status of taxes on the dispute.
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 : 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: string
Title:
Bill Href
The bill's href. -
id: 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
object
Money
Title:
Money
An amount of 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
object
Money
Title:
Money
An amount of money.
Nested Schema : Money
Type:
object
Title:
Money
An amount of money.
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. -
unit: string
Title:
Currency
An ISO 4217 three letter currency code. -
value: number
(float)
Title:
Amount
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
object
Money
Title:
Money
An amount of 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
object
Money
Title:
Money
An amount of money.
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 disputed balances by submitting a GET request on the REST resource using cURL. For more information about cURL, see Use cURL.
The request uses the bill.id query parameter to show only disputed balances for the specified bill.
curl -X GET 'http://host:port/brm/prepayBalanceManagement/version/disputeBalance?bill.id=0.0.0.1+-bill+58925
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+56959", "href": "http://host:port/brm/prepayBalanceManagement/version/disputeBalance/0.0.0.1+-item-dispute+56959", "actionType": "BillDispute", "disputeNo": "D1-24", "amount": { "amount": -40.0, "units": "USD", "@baseType": null, "@schemaLocation": null, "@type": null }, "taxAmount": null, "reason": "1", "description": "", "partyAccount": { "id": "0.0.0.1+-account+56028", "href": null, "description": null, "name": "Alice Quinlan", "status": null, "@baseType": null, "@schemaLocation": null, "@type": null, "@referredType": null }, "discount": null, "taxTreatment": "TaxExcluded", "confirmationDate": "2020-06-24T23:31:13-07:00", "requestedDate": "2020-06-24T23:31:13-07:00", "billingCycleSpecification": { "id": "0.0.0.1+-billinfo+53724", "href": "http://host:port/brm/accountManagement/version/billingCycleSpecification/0.0.0.1+-billinfo+53724", "name": "Bill Unit(1)" }, "bill": { "id": "0.0.0.1+-bill+58925", "href": "http://host:port/brm/customerBillManagement/version/customerBill/0.0.0.1+-bill+58925", "@baseType": null, "@schemaLocation": null, "@type": "BillRef", "@referredType": "CustomerBill" }, "billItem": [ { "id": "0.0.0.1+-item-misc+55612", "href": "http://host:port/brm/customerBillManagement/version/appliedCustomerBillingRate/0.0.0.1+-item-misc+55612", "name": "Usage", "originalCharge": { "unit": "USD", "value": 10.0 }, "disputeAmount": { "unit": "USD", "value": -0.71 } }, { "id": "0.0.0.1+-item-cycle_forward+55484", "href": "http://host:port/brm/customerBillManagement/version/appliedCustomerBillingRate/0.0.0.1+-item-cycle_forward+55484", "name": "Cycle forward", "originalCharge": { "unit": "USD", "value": 20.65 }, "disputeAmount": { "unit": "USD", "value": -18.65 } }, { "id": "0.0.0.1+-item-cycle_forward+56380", "href": "http://host:port/brm/customerBillManagement/version/appliedCustomerBillingRate/0.0.0.1+-item-cycle_forward+56380", "name": "Cycle forward", "originalCharge": { "unit": "USD", "value": 20.64 }, "disputeAmount": { "unit": "USD", "value": -20.64 } } ], "billEvent": null, "status": "Open", "settlementId": null, "@baseType": "DisputeBalanceOracle", "@schemaLocation": null, "@type": "DisputeBalanceOracle" }