Jump to

• Request
• Response
• Examples

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. Use @type=DisputeBalanceOracle for an extended object.
• bill.id: string
  Retrieves disputes for the bill with the specified bill item ID or bill number.

  Examples

  Select an example bill.id=0.0.0.1+-bill+105773 bill.id=Bill-123

• billEvent.id: string
  Retrieves disputes for the specified bill event.

  Examples

  Select an 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 bill item ID or bill item number.

  Examples

  Select an example billItem.id=0.0.0.1+-item-cycle_forward+108813 billItem.id=B1-3,3

• billStructure.id:
• billingCycleSpecification.id: string
  Retrieves disputes for the billing cycle specification with the specified ID.

  Examples

  Select an example billingCycleSpecification.id=0.0.0.1+-billinfo+107765

• confirmationDate: string
  Retrieves disputes with a confirmationDate that is equal to the specified date and time.

  Examples

  Select an example confirmationDate=2025-01-01T04:00:27-08:00

• confirmationDate.gt: string
  Retrieves disputes with a confirmationDate that is greater than the specified date and time.

  Examples

  Select an example confirmationDate.gt=2025-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.

  Examples

  Select an example confirmationDate.gte=2025-01-01T04:00:27-08:00

• confirmationDate.lt: string
  Retrieves disputes with a confirmationDate that is less than the specified date and time.

  Examples

  Select an example confirmationDate.lt=2025-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.

  Examples

  Select an example confirmationDate.lte=2025-01-01T04:00:27-08:00

• fields: string
  The list of comma-separated fields to return in the response.

  Examples

  Select an example fields=amount,billItem

• id: string
  Retrieves the dispute with the specified ID or dispute number.

  Examples

  Select an example id=0.0.0.1+-item-dispute+209114

• limit: integer
  The maximum number of results to return.

  Examples

  Select an example Use limit=10 to return the first 10 results only.

• offset: integer
  The number of results to offset the response by.

  Examples

  Select an example Use offset=10 to return results 10 and higher.

• partyAccount.id: string
  Retrieves the disputes associated with the brm account ID, external account ID or account number.

  Examples

  Select an example partyAccount.id=0.0.0.1-52207 partyAccount.id=0.0.0.1+-account+140598 partyAccount.id=test_account_140598

• requestedDate: string
  Retrieves disputes with a requestedDate that is equal to the specified date and time.

  Examples

  Select an example requestedDate=2025-01-01T04:00:27-08:00

• requestedDate.gt: string
  Retrieves disputes with a requestedDate that is greater than the specified date and time.

  Examples

  Select an example requestedDate.gt=2025-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.

  Examples

  Select an example requestedDate.gte=2025-01-01T04:00:27-08:00

• requestedDate.lt: string
  Retrieves disputes with a requestedDate that is less than the specified date and time.

  Examples

  Select an example requestedDate.lt=2025-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.

  Examples

  Select an example requestedDate.lte=2025-01-01T04:00:27-08:00

• status: string
  Retrieves disputes by status.

  Examples

  Select an example status=Open

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json;charset=utf-8

200 Response

The disputed balances were retrieved successfully.

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.

Body ()

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: BillDispute, ItemDispute, or EventDispute.
• amount: object Quantity
  Represents an amount in a specified unit.
• bill(required): object Bill Ref
  Title: Bill Ref

  A reference to a bill.
• billEvent: array billEvent
  The events are 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.
• billStructure: object Bill Structure Ref
  Title: Bill Structure Ref

  A reference to a bill structure, extended for BRM REST Services Manager.
• 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 display 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: Settled or Open.
• taxAmount: object Quantity
  Represents an amount in a specified unit.
• taxTreatment: string
  Title: Tax Treatment

  Allowed Values: [ "TaxIncluded", "TaxExcluded", "TaxOnly" ]

  The status of taxes on the dispute: TaxIncluded, TaxExcluded, or TaxOnly.

{
    "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&colon; <b>BillDispute</b>, <b>ItemDispute</b>, or <b>EventDispute</b>.",
            "enum":[
                "BillDispute",
                "ItemDispute",
                "EventDispute"
            ]
        },
        "disputeNo":{
            "title":"Dispute Number",
            "type":"string",
            "description":"The dispute number to display 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&colon; <b>TaxIncluded</b>, <b>TaxExcluded</b>, or <b>TaxOnly</b>.",
            "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"
        },
        "billStructure":{
            "description":"The bill structure associated with the dispute.",
            "$ref":"#/components/schemas/BillStructureRef"
        },
        "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":"The events are associated with the dispute.",
            "items":{
                "$ref":"#/components/schemas/BillEventDisputeOracle"
            }
        },
        "status":{
            "title":"Status",
            "type":"string",
            "description":"The dispute's status&colon; <b>Settled</b> or <b>Open</b>.",
            "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

Represents an amount in a specified unit.

Show Source

• amount: number (double)
  Default Value: 1

  The numeric value in the specified unit.
• units: string
  The unit.

{
    "type":"object",
    "description":"Represents an amount in a specified unit.",
    "properties":{
        "amount":{
            "type":"number",
            "nullable":true,
            "format":"double",
            "default":1,
            "description":"The numeric value in the specified unit."
        },
        "units":{
            "type":"string",
            "nullable":true,
            "description":"The 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: string
  Title: Bill Href

  The bill's href.
• id: 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."
        }
    }
}

Nested Schema : billEvent

Type: array

The events are associated with the dispute.

Show Source

• Array of: object BillEvent Dispute Oracle
  Title: BillEvent Dispute Oracle

  A disputed bill event.

{
    "type":"array",
    "description":"The events are 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 : Bill Structure Ref

Type: object

Title: Bill Structure Ref

A reference to a bill structure, extended for BRM REST Services Manager.

Show Source

• href: string
  Title: Href

  The bill structure's href.
• id: string
  Title: ID

  The bill structure's ID.
• name: string
  Title: Name

  The bill structure's name.

{
    "title":"Bill Structure Ref",
    "description":"A reference to a bill structure, extended for BRM REST Services Manager.",
    "type":"object",
    "properties":{
        "id":{
            "title":"ID",
            "type":"string",
            "description":"The bill structure's ID."
        },
        "href":{
            "type":"string",
            "title":"Href",
            "description":"The bill structure's href."
        },
        "name":{
            "type":"string",
            "title":"Name",
            "description":"The bill structure's name."
        }
    }
}

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":{
        "@baseType":{
            "type":"string",
            "title":"Base Type",
            "description":"The object's superclass."
        },
        "@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."
        },
        "@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":{
            "type":"string",
            "title":"Description",
            "description":"The party account's description."
        },
        "href":{
            "type":"string",
            "title":"Href",
            "description":"The party account's href."
        },
        "id":{
            "type":"string",
            "title":"Account ID",
            "description":"The party account's ID."
        },
        "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&colon; <b>due</b>, <b>paid</b>, or <b>in arrears</b>."
        }
    },
    "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
  Represents a monetary amount.
• 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
  Represents a monetary amount.

{
    "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

Represents a monetary amount.

Show Source

• unit: string
  The currency's ISO 4217 three-letter code.
• value: number (double)
  A signed floating-point number whose sign depends on the API context.

{
    "type":"object",
    "description":"Represents a monetary amount.",
    "properties":{
        "unit":{
            "type":"string",
            "nullable":true,
            "description":"The currency's ISO 4217 three-letter code."
        },
        "value":{
            "type":"number",
            "nullable":true,
            "format":"double",
            "description":"A signed floating-point number whose sign depends on the API context."
        }
    }
}

Nested Schema : BillItem Dispute Oracle

Type: object

Title: BillItem Dispute Oracle

A disputed bill item (AppliedCustomerBillingRate).

Show Source

• adjustmentAmount: object Money
  Represents a monetary amount.
• 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
  Represents a monetary amount.

{
    "required":[
        "id",
        "href",
        "name"
    ],
    "title":"BillItem Dispute Oracle",
    "description":"A disputed bill item (<b>AppliedCustomerBillingRate</b>).",
    "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

The request isn't valid.

Body ()

Root Schema : Error

Represents an error returned by an API, typically with an HTTP 3xx, 4xx, or 5xx response code.

Match All

Represents an error returned by an API, typically with an HTTP 3xx, 4xx, or 5xx response code.

Represents an error returned by an API, typically with an HTTP 3xx, 4xx, or 5xx response code.

Show Source

• object Extensible
  Represents a base extensible schema for TM Forum Open APIs. The entity must include @type.
• object Error-allOf[1]

{
    "allOf":[
        {
            "$ref":"#/components/schemas/Extensible"
        },
        {
            "type":"object",
            "required":[
                "code",
                "reason"
            ],
            "properties":{
                "code":{
                    "type":"string",
                    "description":"The application-specific error detail defined by the API or a common list."
                },
                "reason":{
                    "type":"string",
                    "description":"Explains the error to a client user."
                },
                "message":{
                    "type":"string",
                    "description":"Provides error details and corrective actions for a client user."
                },
                "status":{
                    "type":"string",
                    "description":"The HTTP error code extension."
                },
                "referenceError":{
                    "type":"string",
                    "description":"The URI of documentation that describes the error."
                }
            }
        }
    ],
    "description":"Represents an error returned by an API, typically with an HTTP 3xx, 4xx, or 5xx response code."
}

Nested Schema : Extensible

Type: object

Represents a base extensible schema for TM Forum Open APIs. The entity must include @type.

Show Source

• @baseType: string
  The superclass.
• @schemaLocation: string
  The URI of a JSON Schema file that defines additional attributes and relationships.
• @type(required): string
  The subclass Extensible name.

{
    "type":"object",
    "description":"Represents a base extensible schema for TM Forum Open APIs. The entity must include @type.",
    "properties":{
        "@type":{
            "type":"string",
            "nullable":true,
            "description":"The subclass Extensible name."
        },
        "@baseType":{
            "type":"string",
            "nullable":true,
            "description":"The superclass."
        },
        "@schemaLocation":{
            "type":"string",
            "nullable":true,
            "description":"The URI of a JSON Schema file that defines additional attributes and relationships."
        }
    },
    "required":[
        "@type"
    ]
}

Nested Schema : Error-allOf[1]

Type: object

Show Source

• code(required): string
  The application-specific error detail defined by the API or a common list.
• message: string
  Provides error details and corrective actions for a client user.
• reason(required): string
  Explains the error to a client user.
• referenceError: string
  The URI of documentation that describes the error.
• status: string
  The HTTP error code extension.

{
    "type":"object",
    "required":[
        "code",
        "reason"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"The application-specific error detail defined by the API or a common list."
        },
        "reason":{
            "type":"string",
            "description":"Explains the error to a client user."
        },
        "message":{
            "type":"string",
            "description":"Provides error details and corrective actions for a client user."
        },
        "status":{
            "type":"string",
            "description":"The HTTP error code extension."
        },
        "referenceError":{
            "type":"string",
            "description":"The URI of documentation that describes the error."
        }
    }
}

401 Response

The client doesn't have the correct privileges.

Body ()

Root Schema : Error

Represents an error returned by an API, typically with an HTTP 3xx, 4xx, or 5xx response code.

Match All

Represents an error returned by an API, typically with an HTTP 3xx, 4xx, or 5xx response code.

Represents an error returned by an API, typically with an HTTP 3xx, 4xx, or 5xx response code.

Show Source

• object Extensible
  Represents a base extensible schema for TM Forum Open APIs. The entity must include @type.
• object Error-allOf[1]

{
    "allOf":[
        {
            "$ref":"#/components/schemas/Extensible"
        },
        {
            "type":"object",
            "required":[
                "code",
                "reason"
            ],
            "properties":{
                "code":{
                    "type":"string",
                    "description":"The application-specific error detail defined by the API or a common list."
                },
                "reason":{
                    "type":"string",
                    "description":"Explains the error to a client user."
                },
                "message":{
                    "type":"string",
                    "description":"Provides error details and corrective actions for a client user."
                },
                "status":{
                    "type":"string",
                    "description":"The HTTP error code extension."
                },
                "referenceError":{
                    "type":"string",
                    "description":"The URI of documentation that describes the error."
                }
            }
        }
    ],
    "description":"Represents an error returned by an API, typically with an HTTP 3xx, 4xx, or 5xx response code."
}

Nested Schema : Extensible

Type: object

Represents a base extensible schema for TM Forum Open APIs. The entity must include @type.

Show Source

• @baseType: string
  The superclass.
• @schemaLocation: string
  The URI of a JSON Schema file that defines additional attributes and relationships.
• @type(required): string
  The subclass Extensible name.

{
    "type":"object",
    "description":"Represents a base extensible schema for TM Forum Open APIs. The entity must include @type.",
    "properties":{
        "@type":{
            "type":"string",
            "nullable":true,
            "description":"The subclass Extensible name."
        },
        "@baseType":{
            "type":"string",
            "nullable":true,
            "description":"The superclass."
        },
        "@schemaLocation":{
            "type":"string",
            "nullable":true,
            "description":"The URI of a JSON Schema file that defines additional attributes and relationships."
        }
    },
    "required":[
        "@type"
    ]
}

Nested Schema : Error-allOf[1]

Type: object

Show Source

• code(required): string
  The application-specific error detail defined by the API or a common list.
• message: string
  Provides error details and corrective actions for a client user.
• reason(required): string
  Explains the error to a client user.
• referenceError: string
  The URI of documentation that describes the error.
• status: string
  The HTTP error code extension.

{
    "type":"object",
    "required":[
        "code",
        "reason"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"The application-specific error detail defined by the API or a common list."
        },
        "reason":{
            "type":"string",
            "description":"Explains the error to a client user."
        },
        "message":{
            "type":"string",
            "description":"Provides error details and corrective actions for a client user."
        },
        "status":{
            "type":"string",
            "description":"The HTTP error code extension."
        },
        "referenceError":{
            "type":"string",
            "description":"The URI of documentation that describes the error."
        }
    }
}

403 Response

The request wasn't authorized.

Body ()

Root Schema : Error

Represents an error returned by an API, typically with an HTTP 3xx, 4xx, or 5xx response code.

Match All

Represents an error returned by an API, typically with an HTTP 3xx, 4xx, or 5xx response code.

Represents an error returned by an API, typically with an HTTP 3xx, 4xx, or 5xx response code.

Show Source

• object Extensible
  Represents a base extensible schema for TM Forum Open APIs. The entity must include @type.
• object Error-allOf[1]

{
    "allOf":[
        {
            "$ref":"#/components/schemas/Extensible"
        },
        {
            "type":"object",
            "required":[
                "code",
                "reason"
            ],
            "properties":{
                "code":{
                    "type":"string",
                    "description":"The application-specific error detail defined by the API or a common list."
                },
                "reason":{
                    "type":"string",
                    "description":"Explains the error to a client user."
                },
                "message":{
                    "type":"string",
                    "description":"Provides error details and corrective actions for a client user."
                },
                "status":{
                    "type":"string",
                    "description":"The HTTP error code extension."
                },
                "referenceError":{
                    "type":"string",
                    "description":"The URI of documentation that describes the error."
                }
            }
        }
    ],
    "description":"Represents an error returned by an API, typically with an HTTP 3xx, 4xx, or 5xx response code."
}

Nested Schema : Extensible

Type: object

Represents a base extensible schema for TM Forum Open APIs. The entity must include @type.

Show Source

• @baseType: string
  The superclass.
• @schemaLocation: string
  The URI of a JSON Schema file that defines additional attributes and relationships.
• @type(required): string
  The subclass Extensible name.

{
    "type":"object",
    "description":"Represents a base extensible schema for TM Forum Open APIs. The entity must include @type.",
    "properties":{
        "@type":{
            "type":"string",
            "nullable":true,
            "description":"The subclass Extensible name."
        },
        "@baseType":{
            "type":"string",
            "nullable":true,
            "description":"The superclass."
        },
        "@schemaLocation":{
            "type":"string",
            "nullable":true,
            "description":"The URI of a JSON Schema file that defines additional attributes and relationships."
        }
    },
    "required":[
        "@type"
    ]
}

Nested Schema : Error-allOf[1]

Type: object

Show Source

• code(required): string
  The application-specific error detail defined by the API or a common list.
• message: string
  Provides error details and corrective actions for a client user.
• reason(required): string
  Explains the error to a client user.
• referenceError: string
  The URI of documentation that describes the error.
• status: string
  The HTTP error code extension.

{
    "type":"object",
    "required":[
        "code",
        "reason"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"The application-specific error detail defined by the API or a common list."
        },
        "reason":{
            "type":"string",
            "description":"Explains the error to a client user."
        },
        "message":{
            "type":"string",
            "description":"Provides error details and corrective actions for a client user."
        },
        "status":{
            "type":"string",
            "description":"The HTTP error code extension."
        },
        "referenceError":{
            "type":"string",
            "description":"The URI of documentation that describes the error."
        }
    }
}

404 Response

The requested resource couldn't be found.

Body ()

Root Schema : Error

Represents an error returned by an API, typically with an HTTP 3xx, 4xx, or 5xx response code.

Match All

Represents an error returned by an API, typically with an HTTP 3xx, 4xx, or 5xx response code.

Represents an error returned by an API, typically with an HTTP 3xx, 4xx, or 5xx response code.

Show Source

• object Extensible
  Represents a base extensible schema for TM Forum Open APIs. The entity must include @type.
• object Error-allOf[1]

{
    "allOf":[
        {
            "$ref":"#/components/schemas/Extensible"
        },
        {
            "type":"object",
            "required":[
                "code",
                "reason"
            ],
            "properties":{
                "code":{
                    "type":"string",
                    "description":"The application-specific error detail defined by the API or a common list."
                },
                "reason":{
                    "type":"string",
                    "description":"Explains the error to a client user."
                },
                "message":{
                    "type":"string",
                    "description":"Provides error details and corrective actions for a client user."
                },
                "status":{
                    "type":"string",
                    "description":"The HTTP error code extension."
                },
                "referenceError":{
                    "type":"string",
                    "description":"The URI of documentation that describes the error."
                }
            }
        }
    ],
    "description":"Represents an error returned by an API, typically with an HTTP 3xx, 4xx, or 5xx response code."
}

Nested Schema : Extensible

Type: object

Represents a base extensible schema for TM Forum Open APIs. The entity must include @type.

Show Source

• @baseType: string
  The superclass.
• @schemaLocation: string
  The URI of a JSON Schema file that defines additional attributes and relationships.
• @type(required): string
  The subclass Extensible name.

{
    "type":"object",
    "description":"Represents a base extensible schema for TM Forum Open APIs. The entity must include @type.",
    "properties":{
        "@type":{
            "type":"string",
            "nullable":true,
            "description":"The subclass Extensible name."
        },
        "@baseType":{
            "type":"string",
            "nullable":true,
            "description":"The superclass."
        },
        "@schemaLocation":{
            "type":"string",
            "nullable":true,
            "description":"The URI of a JSON Schema file that defines additional attributes and relationships."
        }
    },
    "required":[
        "@type"
    ]
}

Nested Schema : Error-allOf[1]

Type: object

Show Source

• code(required): string
  The application-specific error detail defined by the API or a common list.
• message: string
  Provides error details and corrective actions for a client user.
• reason(required): string
  Explains the error to a client user.
• referenceError: string
  The URI of documentation that describes the error.
• status: string
  The HTTP error code extension.

{
    "type":"object",
    "required":[
        "code",
        "reason"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"The application-specific error detail defined by the API or a common list."
        },
        "reason":{
            "type":"string",
            "description":"Explains the error to a client user."
        },
        "message":{
            "type":"string",
            "description":"Provides error details and corrective actions for a client user."
        },
        "status":{
            "type":"string",
            "description":"The HTTP error code extension."
        },
        "referenceError":{
            "type":"string",
            "description":"The URI of documentation that describes the error."
        }
    }
}

405 Response

This method is not allowed.

Body ()

Root Schema : Error

Represents an error returned by an API, typically with an HTTP 3xx, 4xx, or 5xx response code.

Match All

Represents an error returned by an API, typically with an HTTP 3xx, 4xx, or 5xx response code.

Represents an error returned by an API, typically with an HTTP 3xx, 4xx, or 5xx response code.

Show Source

• object Extensible
  Represents a base extensible schema for TM Forum Open APIs. The entity must include @type.
• object Error-allOf[1]

{
    "allOf":[
        {
            "$ref":"#/components/schemas/Extensible"
        },
        {
            "type":"object",
            "required":[
                "code",
                "reason"
            ],
            "properties":{
                "code":{
                    "type":"string",
                    "description":"The application-specific error detail defined by the API or a common list."
                },
                "reason":{
                    "type":"string",
                    "description":"Explains the error to a client user."
                },
                "message":{
                    "type":"string",
                    "description":"Provides error details and corrective actions for a client user."
                },
                "status":{
                    "type":"string",
                    "description":"The HTTP error code extension."
                },
                "referenceError":{
                    "type":"string",
                    "description":"The URI of documentation that describes the error."
                }
            }
        }
    ],
    "description":"Represents an error returned by an API, typically with an HTTP 3xx, 4xx, or 5xx response code."
}

Nested Schema : Extensible

Type: object

Represents a base extensible schema for TM Forum Open APIs. The entity must include @type.

Show Source

• @baseType: string
  The superclass.
• @schemaLocation: string
  The URI of a JSON Schema file that defines additional attributes and relationships.
• @type(required): string
  The subclass Extensible name.

{
    "type":"object",
    "description":"Represents a base extensible schema for TM Forum Open APIs. The entity must include @type.",
    "properties":{
        "@type":{
            "type":"string",
            "nullable":true,
            "description":"The subclass Extensible name."
        },
        "@baseType":{
            "type":"string",
            "nullable":true,
            "description":"The superclass."
        },
        "@schemaLocation":{
            "type":"string",
            "nullable":true,
            "description":"The URI of a JSON Schema file that defines additional attributes and relationships."
        }
    },
    "required":[
        "@type"
    ]
}

Nested Schema : Error-allOf[1]

Type: object

Show Source

• code(required): string
  The application-specific error detail defined by the API or a common list.
• message: string
  Provides error details and corrective actions for a client user.
• reason(required): string
  Explains the error to a client user.
• referenceError: string
  The URI of documentation that describes the error.
• status: string
  The HTTP error code extension.

{
    "type":"object",
    "required":[
        "code",
        "reason"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"The application-specific error detail defined by the API or a common list."
        },
        "reason":{
            "type":"string",
            "description":"Explains the error to a client user."
        },
        "message":{
            "type":"string",
            "description":"Provides error details and corrective actions for a client user."
        },
        "status":{
            "type":"string",
            "description":"The HTTP error code extension."
        },
        "referenceError":{
            "type":"string",
            "description":"The URI of documentation that describes the error."
        }
    }
}

409 Response

The request could not be processed due to the conflict with the existing state of the resource.

Body ()

Root Schema : Error

Represents an error returned by an API, typically with an HTTP 3xx, 4xx, or 5xx response code.

Match All

Represents an error returned by an API, typically with an HTTP 3xx, 4xx, or 5xx response code.

Represents an error returned by an API, typically with an HTTP 3xx, 4xx, or 5xx response code.

Show Source

• object Extensible
  Represents a base extensible schema for TM Forum Open APIs. The entity must include @type.
• object Error-allOf[1]

{
    "allOf":[
        {
            "$ref":"#/components/schemas/Extensible"
        },
        {
            "type":"object",
            "required":[
                "code",
                "reason"
            ],
            "properties":{
                "code":{
                    "type":"string",
                    "description":"The application-specific error detail defined by the API or a common list."
                },
                "reason":{
                    "type":"string",
                    "description":"Explains the error to a client user."
                },
                "message":{
                    "type":"string",
                    "description":"Provides error details and corrective actions for a client user."
                },
                "status":{
                    "type":"string",
                    "description":"The HTTP error code extension."
                },
                "referenceError":{
                    "type":"string",
                    "description":"The URI of documentation that describes the error."
                }
            }
        }
    ],
    "description":"Represents an error returned by an API, typically with an HTTP 3xx, 4xx, or 5xx response code."
}

Nested Schema : Extensible

Type: object

Represents a base extensible schema for TM Forum Open APIs. The entity must include @type.

Show Source

• @baseType: string
  The superclass.
• @schemaLocation: string
  The URI of a JSON Schema file that defines additional attributes and relationships.
• @type(required): string
  The subclass Extensible name.

{
    "type":"object",
    "description":"Represents a base extensible schema for TM Forum Open APIs. The entity must include @type.",
    "properties":{
        "@type":{
            "type":"string",
            "nullable":true,
            "description":"The subclass Extensible name."
        },
        "@baseType":{
            "type":"string",
            "nullable":true,
            "description":"The superclass."
        },
        "@schemaLocation":{
            "type":"string",
            "nullable":true,
            "description":"The URI of a JSON Schema file that defines additional attributes and relationships."
        }
    },
    "required":[
        "@type"
    ]
}

Nested Schema : Error-allOf[1]

Type: object

Show Source

• code(required): string
  The application-specific error detail defined by the API or a common list.
• message: string
  Provides error details and corrective actions for a client user.
• reason(required): string
  Explains the error to a client user.
• referenceError: string
  The URI of documentation that describes the error.
• status: string
  The HTTP error code extension.

{
    "type":"object",
    "required":[
        "code",
        "reason"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"The application-specific error detail defined by the API or a common list."
        },
        "reason":{
            "type":"string",
            "description":"Explains the error to a client user."
        },
        "message":{
            "type":"string",
            "description":"Provides error details and corrective actions for a client user."
        },
        "status":{
            "type":"string",
            "description":"The HTTP error code extension."
        },
        "referenceError":{
            "type":"string",
            "description":"The URI of documentation that describes the error."
        }
    }
}

500 Response

The system encountered an internal error.

Body ()

Root Schema : Error

Represents an error returned by an API, typically with an HTTP 3xx, 4xx, or 5xx response code.

Match All

Represents an error returned by an API, typically with an HTTP 3xx, 4xx, or 5xx response code.

Represents an error returned by an API, typically with an HTTP 3xx, 4xx, or 5xx response code.

Show Source

• object Extensible
  Represents a base extensible schema for TM Forum Open APIs. The entity must include @type.
• object Error-allOf[1]

{
    "allOf":[
        {
            "$ref":"#/components/schemas/Extensible"
        },
        {
            "type":"object",
            "required":[
                "code",
                "reason"
            ],
            "properties":{
                "code":{
                    "type":"string",
                    "description":"The application-specific error detail defined by the API or a common list."
                },
                "reason":{
                    "type":"string",
                    "description":"Explains the error to a client user."
                },
                "message":{
                    "type":"string",
                    "description":"Provides error details and corrective actions for a client user."
                },
                "status":{
                    "type":"string",
                    "description":"The HTTP error code extension."
                },
                "referenceError":{
                    "type":"string",
                    "description":"The URI of documentation that describes the error."
                }
            }
        }
    ],
    "description":"Represents an error returned by an API, typically with an HTTP 3xx, 4xx, or 5xx response code."
}

Nested Schema : Extensible

Type: object

Represents a base extensible schema for TM Forum Open APIs. The entity must include @type.

Show Source

• @baseType: string
  The superclass.
• @schemaLocation: string
  The URI of a JSON Schema file that defines additional attributes and relationships.
• @type(required): string
  The subclass Extensible name.

{
    "type":"object",
    "description":"Represents a base extensible schema for TM Forum Open APIs. The entity must include @type.",
    "properties":{
        "@type":{
            "type":"string",
            "nullable":true,
            "description":"The subclass Extensible name."
        },
        "@baseType":{
            "type":"string",
            "nullable":true,
            "description":"The superclass."
        },
        "@schemaLocation":{
            "type":"string",
            "nullable":true,
            "description":"The URI of a JSON Schema file that defines additional attributes and relationships."
        }
    },
    "required":[
        "@type"
    ]
}

Nested Schema : Error-allOf[1]

Type: object

Show Source

• code(required): string
  The application-specific error detail defined by the API or a common list.
• message: string
  Provides error details and corrective actions for a client user.
• reason(required): string
  Explains the error to a client user.
• referenceError: string
  The URI of documentation that describes the error.
• status: string
  The HTTP error code extension.

{
    "type":"object",
    "required":[
        "code",
        "reason"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"The application-specific error detail defined by the API or a common list."
        },
        "reason":{
            "type":"string",
            "description":"Explains the error to a client user."
        },
        "message":{
            "type":"string",
            "description":"Provides error details and corrective actions for a client user."
        },
        "status":{
            "type":"string",
            "description":"The HTTP error code extension."
        },
        "referenceError":{
            "type":"string",
            "description":"The URI of documentation that describes the error."
        }
    }
}

Back to Top

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.

This request uses the bill.id query parameter set to a bill number to show disputed balances for the specified bill. You can also set the bill.id query parameter to a bill POID.

curl -X GET 'http://host:port/brm/prepayBalanceManagement/version/disputeBalance?bill.id=B1-3'

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": "Adam Baker",
        "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": "B1-3",
        "href": "http://host:port/brm/customerBillManagement/version/customerBill/B1-3",
        "@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"
}

Back to Top