REST Services Manager API for Billing and Revenue Management

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.

Example:

Use @type=DisputeBalance for a base object or @type=DisputeBalanceOracle for an extended object.

bill.id: string
Retrieves disputes for the bill with the specified ID.
Example:
```
bill.id=0.0.0.1+-bill+105773
```

billEvent.id: string

Retrieves disputes for the specified bill event.

Example:

billEvent.id=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.
Example:
```
billItem.id=0.0.0.1+-item-cycle_forward+108813
```
billingCycleSpecification.id: string
Retrieves disputes for the billing cycle specification with the specified ID.
Example:
```
billingCycleSpecification.id=0.0.0.1+-billinfo+107765
```
confirmationDate: string
Retrieve disputes with a confirmationDate that is equal to the specified date and time.
Example:
```
confirmationDate=2020-01-01T04:00:27-08:00
```
confirmationDate.gt: string
Retrieves disputes with a confirmationDate that is greater than the specified date and time.
Example:
```
confirmationDate.gt=2020-01-01T04:00:27-08:00
```
confirmationDate.gte: string
Retrieves disputes with a confirmationDate that is greater than or equal to the specified date and time.
Example:
```
confirmationDate.gte=2020-01-01T04:00:27-08:00
```
confirmationDate.lt: string
Retrieves disputes with a confirmationDate that is less than the specified date and time.
Example:
```
confirmationDate.lt=2020-01-01T04:00:27-08:00
```
confirmationDate.lte: string
Retrieves disputes with a confirmationDate that is less than or equal to the specified date and time.
Example:
```
confirmationDate.lte=2020-01-01T04:00:27-08:00
```
fields: string
The list of comma-separated fields to return in the response.
Example:
```
fields=amount,billItem
```
id: string
Retrieves the dispute with the specified ID.
Example:
```
id=0.0.0.1+-item-dispute+209114
```
limit: integer
The maximum number of results to return.
Example:
```
Use limit=10 to return the first 10 results only.
```
offset: integer
The number of results to offset the response by.
Example:
```
Use offset=10 to return results 10 and higher.
```
requestedDate: string
Retrieves disputes with a requestedDate that is equal to the specified date and time.
Example:
```
requestedDate=2020-01-01T04:00:27-08:00
```
requestedDate.gt: string
Retrieves disputes with a requestedDate that is greater than the specified date and time.
Example:
```
requestedDate.gt=2020-01-01T04:00:27-08:00
```
requestedDate.gte: string
Retrieves disputes with a requestedDate that is greater than or equal to the specified date and time.
Example:
```
requestedDate.gte=2020-01-01T04:00:27-08:00
```
requestedDate.lt: string
Retrieves disputes with a requestedDate that is less than the specified date and time.
Example:
```
requestedDate.lt=2020-01-01T04:00:27-08:00
```
requestedDate.lte: string
Retrieves disputes with a requestedDate that is less than or equal to the specified date and time.
Example:
```
requestedDate.lte=2020-01-01T04:00:27-08:00
```
status: string
Retrieves disputes by status.
Example:
```
status=Open
```

There's no request body for this operation.

Response

Supported Media Types

application/json;charset=utf-8

200 Response

Success

Headers

X-Result-Count:

The number of items returned in the response body.
X-Total-Count:

The total number of items that matched the criteria.

Root Schema : schema

Type: array

Show Source

Array of: object Dispute Balance Oracle

Title: Dispute Balance Oracle

A disputed balance, extended for BRM REST Services Manager.

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/DisputeBalanceOracle"
    }
}

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 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.

{
    "required":[
        "id",
        "href",
        "bill",
        "billingCycleSpecification"
    ],
    "title":"Dispute Balance Oracle",
    "description":"A disputed balance, extended for BRM REST Services Manager.",
    "type":"object",
    "properties":{
        "id":{
            "title":"Dispute ID",
            "type":"string",
            "description":"The disputed balance's ID."
        },
        "href":{
            "title":"Href",
            "type":"string",
            "description":"The disputed balance's href."
        },
        "actionType":{
            "type":"string",
            "title":"Action Type",
            "description":"The type of balance being disputed.",
            "enum":[
                "BillDispute",
                "ItemDispute",
                "EventDispute"
            ]
        },
        "disputeNo":{
            "title":"Dispute Number",
            "type":"string",
            "description":"The dispute number to displayed on a bill."
        },
        "amount":{
            "description":"The disputed amount.",
            "$ref":"#/components/schemas/Quantity"
        },
        "taxAmount":{
            "description":"The tax amount for the dispute.",
            "$ref":"#/components/schemas/Quantity"
        },
        "reason":{
            "title":"Dispute Reason",
            "type":"string",
            "description":"The reason for the dispute."
        },
        "description":{
            "title":"Dispute Description",
            "type":"string",
            "description":"The dispute's description."
        },
        "partyAccount":{
            "description":"The party account associated with the dispute.",
            "$ref":"#/components/schemas/PartyAccountRef"
        },
        "discount":{
            "title":"Discount",
            "type":"string",
            "description":"A discount associated with the dispute."
        },
        "taxTreatment":{
            "title":"Tax Treatment",
            "description":"The status of taxes on the dispute.",
            "type":"string",
            "enum":[
                "TaxIncluded",
                "TaxExcluded",
                "TaxOnly"
            ]
        },
        "confirmationDate":{
            "type":"string",
            "title":"Confirmation Date",
            "description":"The date the dispute was confirmed.",
            "format":"date-time"
        },
        "requestedDate":{
            "type":"string",
            "title":"Requested Date",
            "description":"The date the request was made.",
            "format":"date-time"
        },
        "billingCycleSpecification":{
            "description":"The billing cycle specification associated with the dispute.",
            "$ref":"#/components/schemas/BillingCycleSpecificationRefOracle"
        },
        "bill":{
            "description":"The bill associated with the dispute.",
            "$ref":"#/components/schemas/BillRef"
        },
        "billItem":{
            "type":"array",
            "description":"The bill items associated with the dispute.",
            "items":{
                "$ref":"#/components/schemas/BillItemDisputeOracle"
            }
        },
        "billEvent":{
            "type":"array",
            "description":"Events associated with the dispute.",
            "items":{
                "$ref":"#/components/schemas/BillEventDisputeOracle"
            }
        },
        "status":{
            "title":"Status",
            "type":"string",
            "description":"The dispute's status.",
            "enum":[
                "Settled",
                "Open"
            ]
        },
        "settlementId":{
            "title":"Settlement ID",
            "type":"string",
            "description":"The ID of the settlement associated with the dispute."
        },
        "@baseType":{
            "type":"string",
            "title":"Base Type",
            "description":"The object's superclass."
        },
        "@schemaLocation":{
            "type":"string",
            "title":"Schema Location",
            "description":"A URI to a JSON-Schema file that defines additional attributes and relationships.",
            "format":"uri"
        },
        "@type":{
            "type":"string",
            "title":"Type",
            "description":"The object's subclass."
        }
    }
}

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

{
    "type":"object",
    "description":"An amount in a given unit.",
    "properties":{
        "amount":{
            "default":1,
            "type":"number",
            "format":"float",
            "description":"Numeric value in a given unit."
        },
        "units":{
            "type":"string",
            "description":"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.

{
    "type":"object",
    "title":"Bill Ref",
    "description":"A reference to a bill.",
    "properties":{
        "id":{
            "type":"string",
            "title":"Bill ID",
            "description":"The bill's ID."
        },
        "href":{
            "type":"string",
            "title":"Bill Href",
            "description":"The bill's href."
        },
        "@baseType":{
            "type":"string",
            "title":"Base Type",
            "description":"The object's superclass."
        },
        "@schemaLocation":{
            "type":"string",
            "title":"Schema Location",
            "format":"uri",
            "description":"A URI to a JSON-Schema file that defines additional attributes and relationships"
        },
        "@type":{
            "type":"string",
            "title":"Type",
            "description":"The object's subclass."
        },
        "@referredType":{
            "type":"string",
            "title":"Referred Type",
            "description":"The actual type of the target instance when needed for disambiguation."
        }
    },
    "required":[
        "id",
        "href"
    ]
}

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.

{
    "type":"array",
    "description":"Events associated with the dispute.",
    "items":{
        "$ref":"#/components/schemas/BillEventDisputeOracle"
    }
}

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.

{
    "title":"Billing Cycle Specification Ref Oracle",
    "description":"A reference to a billing cycle specification, extended for BRM REST Services Manager.",
    "type":"object",
    "properties":{
        "id":{
            "title":"ID",
            "type":"string",
            "description":"The billing cycle specification's ID."
        },
        "href":{
            "type":"string",
            "title":"Href",
            "description":"The billing cycle specification's href."
        },
        "name":{
            "type":"string",
            "title":"Name",
            "description":"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).

{
    "type":"array",
    "description":"The bill items associated with the dispute.",
    "items":{
        "$ref":"#/components/schemas/BillItemDisputeOracle"
    }
}

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.

{
    "required":[
        "id"
    ],
    "type":"object",
    "title":"Party Account Ref",
    "properties":{
        "id":{
            "type":"string",
            "title":"Account ID",
            "description":"The party account's ID."
        },
        "href":{
            "type":"string",
            "title":"Href",
            "description":"The party account's href."
        },
        "description":{
            "type":"string",
            "title":"Description",
            "description":"The party account's description."
        },
        "name":{
            "type":"string",
            "title":"Name",
            "description":"The party account's name."
        },
        "status":{
            "type":"string",
            "title":"Status",
            "description":"The overall status of the account. For example, <b>due</b>, <b>paid</b>, or <b>in arrears</b>."
        },
        "@baseType":{
            "type":"string",
            "title":"Base Type",
            "description":"The object's superclass."
        },
        "@schemaLocation":{
            "type":"string",
            "title":"Schema Location",
            "description":"A URI to a JSON-Schema file that defines additional attributes and relationships.",
            "format":"uri"
        },
        "@type":{
            "type":"string",
            "title":"Type",
            "description":"The object's subclass."
        },
        "@referredType":{
            "type":"string",
            "title":"Referred Type",
            "description":"The object's type in the target system, if <b>baseType</b> and <b>type</b> need further disambiguation."
        }
    },
    "description":"A reference to a party account."
}

Nested Schema : BillEvent Dispute Oracle

Type: object

Title: BillEvent Dispute Oracle

A disputed bill event.

Show Source

adjustmentAmount: 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 Money

Title: Money

An amount of money.

{
    "title":"BillEvent Dispute Oracle",
    "description":"A disputed bill event.",
    "type":"object",
    "properties":{
        "id":{
            "title":"Id",
            "type":"string",
            "description":"The disputed event's ID."
        },
        "href":{
            "title":"Href",
            "type":"string",
            "description":"The disputed event's href."
        },
        "name":{
            "title":"Name",
            "type":"string",
            "description":"The disputed event's name."
        },
        "originalCharge":{
            "description":"The original amount charged that is being disputed.",
            "$ref":"#/components/schemas/Money"
        },
        "adjustmentAmount":{
            "description":"The adjusted amount to settle the dispute.",
            "$ref":"#/components/schemas/Money"
        }
    }
}

Nested Schema : Money

Type: object

Title: Money

An amount of money.

Show Source

unit: string

Title: Currency

An ISO 4217 three letter currency code.
value: number (float)

Title: Amount

A positive floating point number.

{
    "type":"object",
    "title":"Money",
    "properties":{
        "unit":{
            "type":"string",
            "title":"Currency",
            "description":"An ISO 4217 three letter currency code."
        },
        "value":{
            "type":"number",
            "title":"Amount",
            "description":"A positive floating point number.",
            "format":"float"
        }
    },
    "description":"An amount of money."
}

Nested Schema : BillItem Dispute Oracle

Type: object

Title: BillItem Dispute Oracle

A disputed bill item (AppliedCustomerBillingRate).

Show Source

adjustmentAmount: 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 Money

Title: Money

An amount of money.

{
    "required":[
        "id",
        "href",
        "name"
    ],
    "title":"BillItem Dispute Oracle",
    "description":"A disputed bill item (AppliedCustomerBillingRate).",
    "type":"object",
    "properties":{
        "id":{
            "title":"Id",
            "type":"string",
            "description":"The disputed item's ID."
        },
        "href":{
            "title":"Href",
            "type":"string",
            "description":"The disputed item's href."
        },
        "name":{
            "title":"Name",
            "type":"string",
            "description":"The disputed item's name."
        },
        "originalCharge":{
            "description":"The original amount charged that is being disputed.",
            "$ref":"#/components/schemas/Money"
        },
        "adjustmentAmount":{
            "description":"The adjusted amount to settle the dispute.",
            "$ref":"#/components/schemas/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 application's error code, defined in the API or a common list.
message: string

Title: Error Message

More 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

{
    "required":[
        "code",
        "reason"
    ],
    "type":"object",
    "title":"Error",
    "properties":{
        "code":{
            "type":"string",
            "title":"Error Code",
            "description":"An application's error code, defined in the API or a common list."
        },
        "reason":{
            "type":"string",
            "title":"Reason",
            "description":"The reason for the error."
        },
        "message":{
            "type":"string",
            "title":"Error Message",
            "description":"More details and corrective actions related to the error."
        },
        "status":{
            "type":"string",
            "title":"Error Status",
            "description":"The HTTP Error code extension"
        },
        "referenceError":{
            "type":"string",
            "title":"Reference Error",
            "description":"A URI to documentation describing the error.",
            "format":"uri"
        },
        "@baseType":{
            "type":"string",
            "title":"Base Type",
            "description":"The object's superclass."
        },
        "@schemaLocation":{
            "type":"string",
            "title":"Schema Location",
            "description":"A URI to a JSON schema file that defines additional attributes and relationships.",
            "format":"uri"
        },
        "@type":{
            "type":"string",
            "title":"Type",
            "description":"The object's subclass."
        }
    },
    "description":"Used when an API returns an error, typically with a HTTP error response-code such as 401 (Unauthorized) or 500 (Internal Server Error)."
}

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 application's error code, defined in the API or a common list.
message: string

Title: Error Message

More 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

{
    "required":[
        "code",
        "reason"
    ],
    "type":"object",
    "title":"Error",
    "properties":{
        "code":{
            "type":"string",
            "title":"Error Code",
            "description":"An application's error code, defined in the API or a common list."
        },
        "reason":{
            "type":"string",
            "title":"Reason",
            "description":"The reason for the error."
        },
        "message":{
            "type":"string",
            "title":"Error Message",
            "description":"More details and corrective actions related to the error."
        },
        "status":{
            "type":"string",
            "title":"Error Status",
            "description":"The HTTP Error code extension"
        },
        "referenceError":{
            "type":"string",
            "title":"Reference Error",
            "description":"A URI to documentation describing the error.",
            "format":"uri"
        },
        "@baseType":{
            "type":"string",
            "title":"Base Type",
            "description":"The object's superclass."
        },
        "@schemaLocation":{
            "type":"string",
            "title":"Schema Location",
            "description":"A URI to a JSON schema file that defines additional attributes and relationships.",
            "format":"uri"
        },
        "@type":{
            "type":"string",
            "title":"Type",
            "description":"The object's subclass."
        }
    },
    "description":"Used when an API returns an error, typically with a HTTP error response-code such as 401 (Unauthorized) or 500 (Internal Server Error)."
}

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 application's error code, defined in the API or a common list.
message: string

Title: Error Message

More 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

{
    "required":[
        "code",
        "reason"
    ],
    "type":"object",
    "title":"Error",
    "properties":{
        "code":{
            "type":"string",
            "title":"Error Code",
            "description":"An application's error code, defined in the API or a common list."
        },
        "reason":{
            "type":"string",
            "title":"Reason",
            "description":"The reason for the error."
        },
        "message":{
            "type":"string",
            "title":"Error Message",
            "description":"More details and corrective actions related to the error."
        },
        "status":{
            "type":"string",
            "title":"Error Status",
            "description":"The HTTP Error code extension"
        },
        "referenceError":{
            "type":"string",
            "title":"Reference Error",
            "description":"A URI to documentation describing the error.",
            "format":"uri"
        },
        "@baseType":{
            "type":"string",
            "title":"Base Type",
            "description":"The object's superclass."
        },
        "@schemaLocation":{
            "type":"string",
            "title":"Schema Location",
            "description":"A URI to a JSON schema file that defines additional attributes and relationships.",
            "format":"uri"
        },
        "@type":{
            "type":"string",
            "title":"Type",
            "description":"The object's subclass."
        }
    },
    "description":"Used when an API returns an error, typically with a HTTP error response-code such as 401 (Unauthorized) or 500 (Internal Server Error)."
}

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 application's error code, defined in the API or a common list.
message: string

Title: Error Message

More 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

{
    "required":[
        "code",
        "reason"
    ],
    "type":"object",
    "title":"Error",
    "properties":{
        "code":{
            "type":"string",
            "title":"Error Code",
            "description":"An application's error code, defined in the API or a common list."
        },
        "reason":{
            "type":"string",
            "title":"Reason",
            "description":"The reason for the error."
        },
        "message":{
            "type":"string",
            "title":"Error Message",
            "description":"More details and corrective actions related to the error."
        },
        "status":{
            "type":"string",
            "title":"Error Status",
            "description":"The HTTP Error code extension"
        },
        "referenceError":{
            "type":"string",
            "title":"Reference Error",
            "description":"A URI to documentation describing the error.",
            "format":"uri"
        },
        "@baseType":{
            "type":"string",
            "title":"Base Type",
            "description":"The object's superclass."
        },
        "@schemaLocation":{
            "type":"string",
            "title":"Schema Location",
            "description":"A URI to a JSON schema file that defines additional attributes and relationships.",
            "format":"uri"
        },
        "@type":{
            "type":"string",
            "title":"Type",
            "description":"The object's subclass."
        }
    },
    "description":"Used when an API returns an error, typically with a HTTP error response-code such as 401 (Unauthorized) or 500 (Internal Server Error)."
}

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 application's error code, defined in the API or a common list.
message: string

Title: Error Message

More 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

{
    "required":[
        "code",
        "reason"
    ],
    "type":"object",
    "title":"Error",
    "properties":{
        "code":{
            "type":"string",
            "title":"Error Code",
            "description":"An application's error code, defined in the API or a common list."
        },
        "reason":{
            "type":"string",
            "title":"Reason",
            "description":"The reason for the error."
        },
        "message":{
            "type":"string",
            "title":"Error Message",
            "description":"More details and corrective actions related to the error."
        },
        "status":{
            "type":"string",
            "title":"Error Status",
            "description":"The HTTP Error code extension"
        },
        "referenceError":{
            "type":"string",
            "title":"Reference Error",
            "description":"A URI to documentation describing the error.",
            "format":"uri"
        },
        "@baseType":{
            "type":"string",
            "title":"Base Type",
            "description":"The object's superclass."
        },
        "@schemaLocation":{
            "type":"string",
            "title":"Schema Location",
            "description":"A URI to a JSON schema file that defines additional attributes and relationships.",
            "format":"uri"
        },
        "@type":{
            "type":"string",
            "title":"Type",
            "description":"The object's subclass."
        }
    },
    "description":"Used when an API returns an error, typically with a HTTP error response-code such as 401 (Unauthorized) or 500 (Internal Server Error)."
}

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 application's error code, defined in the API or a common list.
message: string

Title: Error Message

More 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

{
    "required":[
        "code",
        "reason"
    ],
    "type":"object",
    "title":"Error",
    "properties":{
        "code":{
            "type":"string",
            "title":"Error Code",
            "description":"An application's error code, defined in the API or a common list."
        },
        "reason":{
            "type":"string",
            "title":"Reason",
            "description":"The reason for the error."
        },
        "message":{
            "type":"string",
            "title":"Error Message",
            "description":"More details and corrective actions related to the error."
        },
        "status":{
            "type":"string",
            "title":"Error Status",
            "description":"The HTTP Error code extension"
        },
        "referenceError":{
            "type":"string",
            "title":"Reference Error",
            "description":"A URI to documentation describing the error.",
            "format":"uri"
        },
        "@baseType":{
            "type":"string",
            "title":"Base Type",
            "description":"The object's superclass."
        },
        "@schemaLocation":{
            "type":"string",
            "title":"Schema Location",
            "description":"A URI to a JSON schema file that defines additional attributes and relationships.",
            "format":"uri"
        },
        "@type":{
            "type":"string",
            "title":"Type",
            "description":"The object's subclass."
        }
    },
    "description":"Used when an API returns an error, typically with a HTTP error response-code such as 401 (Unauthorized) or 500 (Internal Server Error)."
}

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 application's error code, defined in the API or a common list.
message: string

Title: Error Message

More 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

{
    "required":[
        "code",
        "reason"
    ],
    "type":"object",
    "title":"Error",
    "properties":{
        "code":{
            "type":"string",
            "title":"Error Code",
            "description":"An application's error code, defined in the API or a common list."
        },
        "reason":{
            "type":"string",
            "title":"Reason",
            "description":"The reason for the error."
        },
        "message":{
            "type":"string",
            "title":"Error Message",
            "description":"More details and corrective actions related to the error."
        },
        "status":{
            "type":"string",
            "title":"Error Status",
            "description":"The HTTP Error code extension"
        },
        "referenceError":{
            "type":"string",
            "title":"Reference Error",
            "description":"A URI to documentation describing the error.",
            "format":"uri"
        },
        "@baseType":{
            "type":"string",
            "title":"Base Type",
            "description":"The object's superclass."
        },
        "@schemaLocation":{
            "type":"string",
            "title":"Schema Location",
            "description":"A URI to a JSON schema file that defines additional attributes and relationships.",
            "format":"uri"
        },
        "@type":{
            "type":"string",
            "title":"Type",
            "description":"The object's subclass."
        }
    },
    "description":"Used when an API returns an error, typically with a HTTP error response-code such as 401 (Unauthorized) or 500 (Internal Server Error)."
}

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": "2025-06-24T23:31:13-07:00",
    "requestedDate": "2025-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"
}