Jump to

• Request
• Response
• Examples

Get Refund Details

get

/bcws/webresources/v1.0/refunds/{id}

Get details about the specified refund.

Request

Path Parameters

• id(required): string
  The ID of the refund, such as 0.0.0.1+-item-refund+123456789220927922.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/xml
• application/json

200 Response

The refund details were returned successfully.

Body ()

Root Schema : refundDetails

Type: object

Show Source

• accountRef: object ResourceRef
• billNo(required): string
  The bill number associated with the refund.
• cycleEnds: string (date-time)
  The date and time the billing cycle ends.
• cycleStarts: string (date-time)
  The date and time the billing cycle starts.
• details: array details
  The list of details about the refund.
• effectiveDate(required): string (date-time)
  The date and time the refund occurred.
• extension: object extension
  The extended attributes.
• id: string
  The ID of the refund.
• notes: object Notes
• refundAmount(required): number
  The amount of the refund.
• refundMethod: string
  The refund method.
• refundStatus: integer (int64)
  The status of the refund.
• refundType: integer (int32)
  The level of the refund. Can be one of the following:

  • 1: Bill-level
  • 2: Bill unit-level (/billinfo)

{
    "required":[
        "billNo",
        "effectiveDate",
        "refundAmount"
    ],
    "type":"object",
    "properties":{
        "extension":{
            "type":"object",
            "description":"The extended attributes."
        },
        "effectiveDate":{
            "type":"string",
            "description":"The date and time the refund occurred.",
            "format":"date-time"
        },
        "id":{
            "type":"string",
            "description":"The ID of the refund."
        },
        "refundStatus":{
            "type":"integer",
            "description":"The status of the refund.",
            "format":"int64"
        },
        "billNo":{
            "type":"string",
            "description":"The bill number associated with the refund."
        },
        "refundAmount":{
            "type":"number",
            "description":"The amount of the refund."
        },
        "cycleStarts":{
            "type":"string",
            "description":"The date and time the billing cycle starts.",
            "format":"date-time"
        },
        "cycleEnds":{
            "type":"string",
            "description":"The date and time the billing cycle ends.",
            "format":"date-time"
        },
        "refundMethod":{
            "type":"string",
            "description":"The refund method."
        },
        "accountRef":{
            "$ref":"#/components/schemas/ResourceRef"
        },
        "notes":{
            "$ref":"#/components/schemas/Notes"
        },
        "refundType":{
            "type":"integer",
            "description":"The level of the refund. Can be one of the following: <ul><li><b>1</b>: Bill-level</li><li><b>2</b>: Bill unit-level (/billinfo)</li></ul>",
            "format":"int32"
        },
        "details":{
            "type":"array",
            "description":"The list of details about the refund.",
            "items":{
                "$ref":"#/components/schemas/Details"
            }
        }
    },
    "xml":{
        "name":"refundDetails"
    }
}

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 : details

Type: array

The list of details about the refund.

Show Source

• Array of: object Details
  The offer details.

{
    "type":"array",
    "description":"The list of details about the refund.",
    "items":{
        "$ref":"#/components/schemas/Details"
    }
}

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 : Details

Type: object

The offer details.

Show Source

• balanceImpactResource(required): string
  The resource that represents the balance impact of the offer.
• fixedAmount: number (float)
  The fixed amount of the offer.
• fixedPriceTag(required): string
  The fixed price tag of the offer.
• scaledAmount: number (float)
  The scaled amount of the offer.
• scaledPriceTag(required): string
  The scaled price tag of the offer.

{
    "required":[
        "balanceImpactResource",
        "fixedPriceTag",
        "scaledPriceTag"
    ],
    "type":"object",
    "properties":{
        "balanceImpactResource":{
            "type":"string",
            "description":"The resource that represents the balance impact of the offer."
        },
        "fixedAmount":{
            "type":"number",
            "description":"The fixed amount of the offer.",
            "format":"float"
        },
        "scaledAmount":{
            "type":"number",
            "description":"The scaled amount of the offer.",
            "format":"float"
        },
        "fixedPriceTag":{
            "type":"string",
            "description":"The fixed price tag of the offer."
        },
        "scaledPriceTag":{
            "type":"string",
            "description":"The scaled price tag of the offer."
        }
    },
    "description":"The offer details."
}

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 a refund's details 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/refunds/0.0.0.1+-item-refund+259386'

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,
    "effectiveDate": 1612185378000,
    "id": "R1-24",
    "refundStatus": 4,
    "billNo": "B1-2",
    "refundAmount": 2.02,
    "cycleStarts": 1586934000000,
    "cycleEnds": 1589526000000,
    "refundMethod": "cash",
    "accountRef": {
        "id": "0.0.0.1+-account+81329",
        "uri": null
    },
    "notes": {
        "extension": null,
        "id": "0.0.0.1+-note+258874",
        "accountId": "0.0.0.1+-account+81329",
        "amount": 2.02,
        "billUnitId": "0.0.0.1+-billinfo+78769",
        "billId": null,
        "closedDate": 1612185379000,
        "count": 1,
        "effectiveDate": 1612185379000,
        "eventId": "0.0.0.0++0",
        "header": "",
        "itemId": "0.0.0.1+-item-refund+259386",
        "subType": 212,
        "type": 200,
        "domainId": 6,
        "reasonId": 1,
        "serviceId": "0.0.0.0+-service-telco-gsm-roaming+678934",
        "status": 101,
        "comments": [
            {
                "csrLoginId": "HeadCSR",
                "csrFirstName": "Alia",
                "csrLastName": "Abadi",
                "csrAccountId": "1234",
                "externalUser": "CSR Portal",
                "comment": "Issued refund for invalid roaming charges.",
                "trackingId": "",
                "entryDate": 1612185379000
            }
        ]
    },
    "refundType": 1,
    "details": [
        {
            "amount": 2.02,
            "itemNo": "B1-2,3",
            "itemName": "Cycle forward",
            "billNo": "B1-2"
        }
    ]
}

Back to Top