1. REST Services Manager API for Billing and Revenue Management
  2. Tasks
  3. Prepay Balance Management
  4. Disputed Balances

Create a Disputed Balance

post

/disputeBalance

Creates a disputed balance.

Request

There are no request parameters for this operation.

Supported Media Types
Request Body - application/json ()
Root Schema : Dispute Balance Create Oracle
Type: object
Title: Dispute Balance Create Oracle
A disputed balance, used in DisputeBalance create requests.
Show Source
Nested Schema : Quantity
Type: object
An amount in a given unit.
Show Source
Nested Schema : bieId
Type: array
The bill, item, or event IDs associated with the dispute.
Show Source
Nested Schema : Party Account Ref
Type: object
Title: Party Account Ref
A reference to a party account.
Show Source
Nested Schema : BIEField Oracle
Type: object
Title: BIEField Oracle
A bill, item, or event, extended for BRM REST Services Manager
Show Source
Back to Top

Response

Supported Media Types

201 Response

Created
Body ()
Root Schema : Dispute Balance Oracle
Type: object
Title: Dispute Balance Oracle
A disputed balance, extended for BRM REST Services Manager.
Show Source
Nested Schema : Quantity
Type: object
An amount in a given unit.
Show Source
Nested Schema : Bill Ref
Type: object
Title: Bill Ref
A reference to a bill.
Show Source
Nested Schema : billEvent
Type: array
Events associated with the dispute.
Show Source
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
Nested Schema : billItem
Type: array
The bill items associated with the dispute.
Show Source
Nested Schema : Party Account Ref
Type: object
Title: Party Account Ref
A reference to a party account.
Show Source
Nested Schema : BillEvent Dispute Oracle
Type: object
Title: BillEvent Dispute Oracle
A disputed bill event.
Show Source
Nested Schema : Money
Type: object
A base / value business entity used to represent money.
Show Source
Nested Schema : BillItem Dispute Oracle
Type: object
Title: BillItem Dispute Oracle
A disputed bill item (AppliedCustomerBillingRate).
Show Source

400 Response

Bad Request
Body ()
Root Schema : Error
Type: object
This is used when an API throws an error, typically with a HTTP error response-code (3xx, 4xx, 5xx).
Show Source

401 Response

Unauthorized
Body ()
Root Schema : Error
Type: object
This is used when an API throws an error, typically with a HTTP error response-code (3xx, 4xx, 5xx).
Show Source

403 Response

Forbidden
Body ()
Root Schema : Error
Type: object
This is used when an API throws an error, typically with a HTTP error response-code (3xx, 4xx, 5xx).
Show Source

405 Response

Method Not allowed
Body ()
Root Schema : Error
Type: object
This is used when an API throws an error, typically with a HTTP error response-code (3xx, 4xx, 5xx).
Show Source

409 Response

Conflict
Body ()
Root Schema : Error
Type: object
This is used when an API throws an error, typically with a HTTP error response-code (3xx, 4xx, 5xx).
Show Source

500 Response

Internal Server Error
Body ()
Root Schema : Error
Type: object
This is used when an API throws an error, typically with a HTTP error response-code (3xx, 4xx, 5xx).
Show Source
Back to Top

Examples

The following example shows how to create a disputed balance for an event by submitting a POST request on the REST resource using cURL. For more information about cURL, see Use cURL.

The -d option specifies the file to attach as the request body.

curl -X POST 'http://host:port/brm/prepayBalanceManagement/version/disputeBalance' -d @disputeBalanceCreate.json

Example of Request Body

The following is an example of the contents of the disputeBalanceCreate.json file sent as the request body. 

{
    "description": "My First Event Dispute",
    "reason": "1",
    "amount": {
        "amount": 1.00,
        "units": "USD"
    },
    "bieId": [
        {
            "id": "0.0.0.1+-event-billing-product-fee-cycle-cycle_forward_monthly+324100843496386447"
        }
    ],
    "taxTreatment": "TaxExcluded"
}

Example of Response Body

The following is an example of the response body in JSON format.

{
    "id": "0.0.0.1+-item-dispute+115931",
    "href": "https://host:port/brm/prepayBalanceManagement/version/disputeBalance/0.0.0.1+-item-dispute+115931",
    "actionType": "EventDispute",
    "disputeNo": null,
    "amount": {
        "amount": -1.0,
        "units": "USD",
        "@baseType": null,
        "@schemaLocation": null,
        "@type": null
    },
    "taxAmount": null,
    "reason": "1",
    "description": "My First Event Dispute",
    "partyAccount": {
        "id": "0.0.0.1+-account+114053",
        "href": null,
        "description": null,
        "name": null,
        "status": null,
        "@baseType": null,
        "@schemaLocation": null,
        "@type": null,
        "@referredType": null
    },
    "validFor": null,
    "discount": null,
    "taxTreatment": null,
    "confirmationDate": null,
    "requestedDate": "2020-06-23T03:24:36-07:00",
    "billingCycleSpecification": null,
    "bill": null,
    "billItem": null,
    "billEvents": null,
    "status": "Open",
    "settlementId": null,
    "@baseType": null,
    "@schemaLocation": null,
    "@type": null
}
Back to Top