Jump to

• Request
• Response
• Examples

Get Write-Off Details

get

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

Gets the details for the write off that matches the specified ID.

Request

Path Parameters

• id(required): string
  The ID of the write off, such as 0.0.0.1+-item-writeoff+123456789779285649.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/xml
• application/json

200 Response

The write-off details were returned successfully.

Body ()

Root Schema : writeOffDetails

Type: object

Show Source

• accountNumber: string
  The account number associated with the write-off.
• actionAffectsRef: object ResourceRef
• billNumber: string
  The bill number associated with the write-off.
• billUnitName: string
  The name of the bill unit associated with the write-off.
• cycleEnds: string (date-time)
  The date and time the cycle ends.
• cycleStarts: string (date-time)
  The date and time the cycle starts.
• effectiveDate: string (date-time)
  The date and time the write-off takes effect.
• extension: object extension
  The extended attributes.
• itemName: string
  The name of the item associated with the write-off.
• itemNumber: string
  The item number associated with the write-off.
• notes: array notes
• reversalAmount: number
  The amount of the write-off reversal.
• reversalEffectiveDate: string (date-time)
  The date and time the write-off reversal takes effect.
• reversalId: string
  The ID of the write-off reversal.
• reversalRef: object ResourceRef
• writeoffAmount(required): number
  The amount to write off.
• writeoffID: string
  The write-off's ID.
• writeoffRef: object ResourceRef
• writeoffType: integer (int64)
  The type of write-off.

{
    "required":[
        "writeoffAmount"
    ],
    "type":"object",
    "properties":{
        "extension":{
            "type":"object",
            "description":"The extended attributes."
        },
        "actionAffectsRef":{
            "$ref":"#/components/schemas/ResourceRef"
        },
        "effectiveDate":{
            "type":"string",
            "description":"The date and time the write-off takes effect.",
            "format":"date-time"
        },
        "writeoffType":{
            "type":"integer",
            "description":"The type of write-off.",
            "format":"int64"
        },
        "cycleStarts":{
            "type":"string",
            "description":"The date and time the cycle starts.",
            "format":"date-time"
        },
        "cycleEnds":{
            "type":"string",
            "description":"The date and time the cycle ends.",
            "format":"date-time"
        },
        "writeoffAmount":{
            "type":"number",
            "description":"The amount to write off."
        },
        "writeoffID":{
            "type":"string",
            "description":"The write-off's ID."
        },
        "itemName":{
            "type":"string",
            "description":"The name of the item associated with the write-off."
        },
        "billNumber":{
            "type":"string",
            "description":"The bill number associated with the write-off."
        },
        "itemNumber":{
            "type":"string",
            "description":"The item number associated with the write-off."
        },
        "billUnitName":{
            "type":"string",
            "description":"The name of the bill unit associated with the write-off."
        },
        "accountNumber":{
            "type":"string",
            "description":"The account number associated with the write-off."
        },
        "notes":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Notes"
            }
        },
        "reversalAmount":{
            "type":"number",
            "description":"The amount of the write-off reversal."
        },
        "reversalEffectiveDate":{
            "type":"string",
            "description":"The date and time the write-off reversal takes effect.",
            "format":"date-time"
        },
        "reversalId":{
            "type":"string",
            "description":"The ID of the write-off reversal."
        },
        "writeoffRef":{
            "$ref":"#/components/schemas/ResourceRef"
        },
        "reversalRef":{
            "$ref":"#/components/schemas/ResourceRef"
        }
    },
    "xml":{
        "name":"writeOffDetails"
    }
}

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

Show Source

• Array of: object Notes

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

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 the details about a write-off 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/writeoffs/0.0.0.1+-item-writeoff+254571'

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,
    "actionAffectsRef": {
        "id": "0.0.0.1+-account+263249",
        "uri": null
    },
    "effectiveDate": 1611931289000,
    "writeoffType": 15,
    "cycleStarts": 1611907200000,
    "cycleEnds": 1614585600000,
    "writeoffAmount": -10.97,
    "writeoffID": "W1-6",
    "itemName": "Cycle forward",
    "billNumber": "B1-951",
    "itemNumber": "",
    "billUnitName": "Bill Unit(1)",
    "accountNumber": null,
    "notes": [
        {
            "extension": null,
            "id": "0.0.0.1+-note+254315",
            "accountId": "0.0.0.1+-account+263249",
            "amount": -10.97,
            "billUnitId": "0.0.0.1+-billinfo+264785",
            "billId": null,
            "closedDate": 1611931290000,
            "count": 1,
            "effectiveDate": 1611931290000,
            "eventId": "0.0.0.0++0",
            "header": "",
            "itemId": "0.0.0.1+-item-writeoff+254571",
            "subType": 213,
            "type": 200,
            "domainId": 45,
            "reasonId": 2,
            "serviceId": "0.0.0.0++0",
            "status": 101,
            "comments": [
                {                
                    "csrLoginId": "HeadCSR",
                    "csrFirstName": "Alia",
                    "csrLastName": "Abadi",
                    "csrAccountId": "1234",
                    "externalUser": "CSR Portal",
                    "comment": "Item never requested, writing off.",
                    "trackingId": "",
                    "entryDate": 1611931290000
                }
            ]
        }
    ],
    "reversalAmount": null,
    "reversalEffectiveDate": null,
    "reversalId": null,
    "writeoffRef": {
        "id": "0.0.0.1+-item-writeoff+254571",
        "uri": null
    },
    "reversalRef": null
}

Back to Top