Jump to

• Request
• Response
• Examples

Get Settlement Details for a Dispute

get

/bcws/webresources/v1.0/disputes/settlement/{id}

Gets settlement details of a dispute

Request

Path Parameters

• id(required): string
  The settlement ID or dispute ID.

Query Parameters

• accountId: string
  The account ID. This parameter is optional.
• billId: string
  The bill ID. This parameter is optional.
• billunitId: string
  The bill unit ID. This parameter is optional.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/xml
• application/json

200 Response

The settlement details were returned successfully.

Body ()

Root Schema : settlementDetails

Type: object

Show Source

• billId(required): string
  The ID of the bill associated with the settlement.
• billingEnd: string (date-time)
  The date and time the billing cycle ends.
• billingStart: string (date-time)
  The date and time the billing cycle starts.
• billNumber: string
  The bill number associated with the settlement.
• disputedAmount(required): number
  The amount of the dispute.
• disputedDate(required): string (date-time)
  The date and time the bill, item, or event was disputed.
• disputeId(required): string
  The ID of the dispute.
• disputeRef: object ResourceRef
• due: number
  The amount due after the settlement.
• eventsCount(required): string
  The number of events associated with the settlement.
• extension: object extension
  The extended attributes.
• itemId(required): string
  The ID of the item associated with the settlement.
• itemName(required): string
  The name of the item associated with the settlement.
• itemNumber(required): string
  The item number associated with the settlement.
• notes: object Notes
• settledDate(required): string (date-time)
  The date and time the dispute was settled.
• settledNonTaxedAmount(required): number
  The non-taxable amount for the bill item settled by the adjustment.
• settledTaxAmount(required): number
  The amount of tax for the bill item settled by the adjustment.
• settledTaxedAmount(required): number
  The taxable amount for the bill item settled by the adjustment.
• settlementAmount(required): number
  The settlement amount. The amount you enter can be all, a portion, or none of the disputed amount.
• settlementId(required): string
  The ID of the settlement.
• settlementRef: object ResourceRef

{
    "required":[
        "billId",
        "disputeId",
        "disputedAmount",
        "disputedDate",
        "eventsCount",
        "itemId",
        "itemName",
        "itemNumber",
        "settledDate",
        "settledNonTaxedAmount",
        "settledTaxAmount",
        "settledTaxedAmount",
        "settlementAmount",
        "settlementId"
    ],
    "type":"object",
    "properties":{
        "extension":{
            "type":"object",
            "description":"The extended attributes."
        },
        "billId":{
            "type":"string",
            "description":"The ID of the bill associated with the settlement."
        },
        "itemId":{
            "type":"string",
            "description":"The ID of the item associated with the settlement."
        },
        "disputedDate":{
            "type":"string",
            "description":"The date and time the bill, item, or event was disputed.",
            "format":"date-time"
        },
        "settledDate":{
            "type":"string",
            "description":"The date and time the dispute was settled.",
            "format":"date-time"
        },
        "disputeId":{
            "type":"string",
            "description":"The ID of the dispute."
        },
        "disputeRef":{
            "$ref":"#/components/schemas/ResourceRef"
        },
        "settlementId":{
            "type":"string",
            "description":"The ID of the settlement."
        },
        "itemName":{
            "type":"string",
            "description":"The name of the item associated with the settlement."
        },
        "itemNumber":{
            "type":"string",
            "description":"The item number associated with the settlement."
        },
        "eventsCount":{
            "type":"string",
            "description":"The number of events associated with the settlement."
        },
        "disputedAmount":{
            "type":"number",
            "description":"The amount of the dispute."
        },
        "settlementAmount":{
            "type":"number",
            "description":"The settlement amount. The amount you enter can be all, a portion, or none of the disputed amount."
        },
        "settlementRef":{
            "$ref":"#/components/schemas/ResourceRef"
        },
        "billNumber":{
            "type":"string",
            "description":"The bill number associated with the settlement."
        },
        "due":{
            "type":"number",
            "description":"The amount due after the settlement."
        },
        "billingStart":{
            "type":"string",
            "description":"The date and time the billing cycle starts.",
            "format":"date-time"
        },
        "billingEnd":{
            "type":"string",
            "description":"The date and time the billing cycle ends.",
            "format":"date-time"
        },
        "settledTaxAmount":{
            "type":"number",
            "description":"The amount of tax for the bill item settled by the adjustment."
        },
        "settledTaxedAmount":{
            "type":"number",
            "description":"The taxable amount for the bill item settled by the adjustment."
        },
        "settledNonTaxedAmount":{
            "type":"number",
            "description":"The non-taxable amount for the bill item settled by the adjustment."
        },
        "notes":{
            "$ref":"#/components/schemas/Notes"
        }
    },
    "xml":{
        "name":"settlementDetails"
    }
}

Nested Schema : ResourceRef

Type: object

Show Source

• id(required): string
  The ID.
• uri: string
  The Uniform Resource Identifier (URI) associated with the resource.

{
    "required":[
        "id"
    ],
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"The ID."
        },
        "uri":{
            "type":"string",
            "description":"The Uniform Resource Identifier (URI) associated with the resource."
        }
    }
}

Nested Schema : extension

Type: object

The extended attributes.

Nested Schema : Notes

Type: object

Show Source

• accountId(required): string
  The ID of the account associated with the note.
• amount: number
  The amount associated with the note. It can be a payment amount, adjustment amount, or so on.
• billId: string
  The ID of the bill associated with the note.
• billUnitId: string
  The ID of the bill unit associated with the note.
• closedDate: string (date-time)
  The date and time the note was resolved.
• comments: array comments
  The list of comments associated with the note.
• count: integer (int32)
  The number of comments associated with the note.
• domainId: integer (int32)
  The domain ID associated with the note.
• effectiveDate: string (date-time)
  The date and time the comment was posted.
• eventId: string
  The ID of the event associated with the note.
• extension: object extension
  The extended attributes.
• header: string
  The header associated with the note.
• id: string
  The ID.
• itemId: string
  The ID of the item associated with the note.
• reasonId: integer (int32)
  The reason ID associated with the note. Possible values are stored in /config/reason_code_scope objects. See Localizing and Customizing Strings in BRM Developer's Guide for information about how to customize these values using the reasons.locale file.
• serviceId: string
  The service ID associated with the note.
• status: number
  The note's status: not set (100), resolved (101), or unresolved (102). The default value is 102.
• subType: integer (int32)
  The note's subtype. Possible values are stored in the /config/note_type object. See Localizing and Customizing Strings in BRM Developer's Guide for information about how to customize these values using the note.locale file.
• type: integer (int32)
  The note's type. Possible values are stored in the /config/note_type object. See Localizing and Customizing Strings in BRM Developer's Guide for information about how to customize these values using the note.locale file.

{
    "required":[
        "accountId"
    ],
    "type":"object",
    "properties":{
        "extension":{
            "type":"object",
            "description":"The extended attributes."
        },
        "id":{
            "type":"string",
            "description":"The ID."
        },
        "accountId":{
            "type":"string",
            "description":"The ID of the account associated with the note."
        },
        "amount":{
            "type":"number",
            "description":"The amount associated with the note. It can be a payment amount, adjustment amount, or so on."
        },
        "billUnitId":{
            "type":"string",
            "description":"The ID of the bill unit associated with the note."
        },
        "billId":{
            "type":"string",
            "description":"The ID of the bill associated with the note."
        },
        "closedDate":{
            "type":"string",
            "description":"The date and time the note was resolved.",
            "format":"date-time"
        },
        "count":{
            "type":"integer",
            "description":"The number of comments associated with the note.",
            "format":"int32"
        },
        "effectiveDate":{
            "type":"string",
            "description":"The date and time the comment was posted.",
            "format":"date-time"
        },
        "eventId":{
            "type":"string",
            "description":"The ID of the event associated with the note."
        },
        "header":{
            "type":"string",
            "description":"The header associated with the note."
        },
        "itemId":{
            "type":"string",
            "description":"The ID of the item associated with the note."
        },
        "subType":{
            "type":"integer",
            "description":"The note's subtype. Possible values are stored in the <b>/config/note_type</b> object. See <a href=\"http://docs.oracle.com/pls/topic/lookup?ctx=brm120&id=GUID-D733989B-5B0E-4643-B70A-77B62A73314D\">Localizing and Customizing Strings</a> in <i>BRM Developer's Guide</i> for information about how to customize these values using the <b>note.</b><i>locale</i> file.",
            "format":"int32"
        },
        "type":{
            "type":"integer",
            "description":"The note's type. Possible values are stored in the <b>/config/note_type</b> object. See <a href=\"http://docs.oracle.com/pls/topic/lookup?ctx=brm120&id=GUID-D733989B-5B0E-4643-B70A-77B62A73314D\">Localizing and Customizing Strings</a> in <i>BRM Developer's Guide</i> for information about how to customize these values using the <b>note.</b><i>locale</i> file.",
            "format":"int32"
        },
        "domainId":{
            "type":"integer",
            "description":"The domain ID associated with the note.",
            "format":"int32"
        },
        "reasonId":{
            "type":"integer",
            "description":"The reason ID associated with the note. Possible values are stored in <b>/config/reason_code_scope</b> objects. See <a href=\"http://docs.oracle.com/pls/topic/lookup?ctx=brm120&id=GUID-D733989B-5B0E-4643-B70A-77B62A73314D\">Localizing and Customizing Strings</a> in <i>BRM Developer's Guide</i> for information about how to customize these values using the <b>reasons.</b><i>locale</i> file.",
            "format":"int32"
        },
        "serviceId":{
            "type":"string",
            "description":"The service ID associated with the note."
        },
        "status":{
            "type":"number",
            "description":"The note's status: not set (<b>100</b>), resolved (<b>101</b>), or unresolved (<b>102</b>). The default value is <b>102</b>."
        },
        "comments":{
            "type":"array",
            "description":"The list of comments associated with the note.",
            "items":{
                "$ref":"#/components/schemas/Comments"
            }
        }
    }
}

Nested Schema : comments

Type: array

The list of comments associated with the note.

Show Source

• Array of: object Comments
  The list of comments associated with the note.

{
    "type":"array",
    "description":"The list of comments associated with the note.",
    "items":{
        "$ref":"#/components/schemas/Comments"
    }
}

Nested Schema : extension

Type: object

The extended attributes.

Nested Schema : Comments

Type: object

The list of comments associated with the note.

Show Source

• comment(required): string
  The comment.
• csrAccountId: string
  The CSR's account ID.
• csrFirstName: string
  The CSR's first name.
• csrLastName: string
  The CSR's last name.
• csrLoginId: string
  The login ID associated with the CSR.
• entryDate: string (date-time)
  The date and time the comment was entered by the CSR.
• externalUser: string
  The external user.
• trackingId: string
  The tracking ID.

{
    "required":[
        "comment"
    ],
    "type":"object",
    "properties":{
        "csrLoginId":{
            "type":"string",
            "description":"The login ID associated with the CSR."
        },
        "csrFirstName":{
            "type":"string",
            "description":"The CSR's first name."
        },
        "csrLastName":{
            "type":"string",
            "description":"The CSR's last name."
        },
        "csrAccountId":{
            "type":"string",
            "description":"The CSR's account ID."
        },
        "externalUser":{
            "type":"string",
            "description":"The external user."
        },
        "comment":{
            "type":"string",
            "description":"The comment."
        },
        "trackingId":{
            "type":"string",
            "description":"The tracking ID."
        },
        "entryDate":{
            "type":"string",
            "description":"The date and time the comment was entered by the CSR.",
            "format":"date-time"
        }
    },
    "description":"The list of comments associated with the note."
}

500 Response

An internal server error occurred.

Back to Top

Examples

This example shows how to get settlement details for a dispute by submitting a GET request on the REST resource using cURL. For more information about cURL, see "Use cURL".

cURL Command

curl -X GET 'http://hostname:port/bcws/webresources/version/disputes/settlement/0.0.0.1+-item-settlement+271994'

where:

• hostname is the URL for the Billing Care REST server.
• port is the port for the Billing Care REST server.
• version is the version of the API you're using, such as v1.0.

Example of Response Body

This example shows the contents of the response body in JSON format.

{
    "extension": null,
    "billId": "0.0.0.1+-bill+347445674378435327",
    "itemId": "0.0.0.1+-item-cycle_forward+349046563308488341",
    "disputedDate": 1700554644000,
    "settledDate": 1700554644000,
    "disputeId": "D1-40",
    "disputeRef": {
        "id": "0.0.0.1+-item-dispute+346249405727699710",
        "uri": null
    },
    "settlementId": "S1-33",
    "itemName": "Cycle forward",
    "itemNumber": "B1-2428,2",
    "eventsCount": null,
    "disputedAmount": -1.12,
    "settlementAmount": -1.12,
    "settlementRef": {
        "id": "0.0.0.1+-item-settlement+271994",
        "uri": null
    },
    "billNumber": "B1-2428",
    "due": 8.83,
    "billingStart": 1706774400000,
    "billingEnd": 1709280000000,
    "settledTaxAmount": 0,
    "settledTaxedAmount": -1.12,
    "settledNonTaxedAmount": 0,
    "notes": {
        "extension": null,
        "id": "0.0.0.1+-note+1505790",
        "accountId": "0.0.0.1+-account+1217781",
        "amount": 1.12,
        "billUnitId": "0.0.0.1+-billinfo+1219317",
        "billId": null,
        "closedDate": 1700554645000,
        "count": 1,
        "effectiveDate": 1700554645000,
        "eventId": "0.0.0.0++0",
        "header": "",
        "itemId": "0.0.0.1+-item-settlement+271994",
        "subType": 209,
        "type": 200,
        "domainId": 25,
        "reasonId": 1,
        "serviceId": "0.0.0.0++0",
        "status": 101,
        "comments": [
            {
                "csrLoginId": null,
                "csrFirstName": null,
                "csrLastName": null,
                "csrAccountId": null,
                "externalUser": "weblogic",
                "comment": "",
                "trackingId": "",
                "entryDate": 1700554645000
            }
        ]
    }
}

Back to Top