Jump to

• Request
• Response
• Examples

Get a Corrective Bill

get

/bcws/webresources/v1.0/bills/correctivebill/{id}

Gets details about a corrective bill that matches the specified ID.

Request

Path Parameters

• id(required): string
  The ID of the corrective bill.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/xml
• application/json

200 Response

The corrective bill was returned successfully.

Body ()

Root Schema : correctiveBillTrail

Type: object

Show Source

• adjusted: number
  The amount of any adjustments.
• arActionsAmtExcludingPayments: number
  The total amount of all accounts receivable actions, excluding any payments.
• billNo: string
  The bill number.
• creationDate(required): string (date-time)
  The date and time the corrective bill was created.
• currentTotal: number
  The current total amount due.
• disputed: number
  The amount of any disputes.
• due: number
  The amount due for the corrective bill.
• dueDate: string (date-time)
  The date and time the corrective bill is due.
• extension: object extension
  The extended attributes.
• invoiceFormat: integer (int32)
  The invoice format. Can be one of the following:

  • 1: Detail
  • 2: Summary
• invoiceType: integer (int32)
  The invoice type. Can be one of the following:

  • 1: Correction letter
  • 2: Replacement invoice
• notes: object Notes
• originalBill: object originalBill
  Information about an original bill.
• receivedForBill: number
  The payment received against the original bill.
• subordsTotal: number
  The total amount due for all subordinate accounts.
• totalDue: number
  The total amount due for the parent account and all child accounts.

{
    "required":[
        "creationDate"
    ],
    "type":"object",
    "properties":{
        "extension":{
            "type":"object",
            "description":"The extended attributes."
        },
        "invoiceFormat":{
            "type":"integer",
            "description":"The invoice format. Can be one of the following: <ul><li><b>1</b>: Detail</li><li><b>2</b>: Summary</li></ul>",
            "format":"int32"
        },
        "invoiceType":{
            "type":"integer",
            "description":"The invoice type. Can be one of the following: <ul><li><b>1</b>: Correction letter</li><li><b>2</b>: Replacement invoice</li></ul>",
            "format":"int32"
        },
        "adjusted":{
            "type":"number",
            "description":"The amount of any adjustments."
        },
        "billNo":{
            "type":"string",
            "description":"The bill number."
        },
        "creationDate":{
            "type":"string",
            "description":"The date and time the corrective bill was created.",
            "format":"date-time"
        },
        "disputed":{
            "type":"number",
            "description":"The amount of any disputes."
        },
        "currentTotal":{
            "type":"number",
            "description":"The current total amount due."
        },
        "arActionsAmtExcludingPayments":{
            "type":"number",
            "description":"The total amount of all accounts receivable actions, excluding any payments."
        },
        "due":{
            "type":"number",
            "description":"The amount due for the corrective bill."
        },
        "totalDue":{
            "type":"number",
            "description":"The total amount due for the parent account and all child accounts."
        },
        "subordsTotal":{
            "type":"number",
            "description":"The total amount due for all subordinate accounts."
        },
        "receivedForBill":{
            "type":"number",
            "description":"The payment received against the original bill."
        },
        "dueDate":{
            "type":"string",
            "description":"The date and time the corrective bill is due.",
            "format":"date-time"
        },
        "originalBill":{
            "$ref":"#/components/schemas/OriginalBill"
        },
        "notes":{
            "$ref":"#/components/schemas/Notes"
        }
    },
    "xml":{
        "name":"correctiveBillTrail"
    }
}

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

Type: object

Information about an original bill.

Show Source

• adjusted: number
  The amount of any adjustments.
• arActionsAmtExcludingPayments: number
  The total amount of all accounts receivable actions, excluding any payments.
• billNo: string
  The bill number.
• creationDate(required): string (date-time)
  The date and time the corrective bill was created.
• currentTotal: number
  The current total amount due.
• disputed: number
  The amount of any disputes.
• due: number
  The amount due for the corrective bill.
• dueDate: string (date-time)
  The date and time the corrective bill is due.
• extension: object extension
  The extended attributes.
• invoiceFormat: integer (int32)
  The invoice format. Can be one of the following:

  • 1: Detail
  • 2: Summary
• invoiceType: integer (int32)
  The invoice type. Can be one of the following:

  • 1: Correction letter
  • 2: Replacement invoice
• originalBill: object originalBill
  Information about an original bill.
• receivedForBill: number
  The payment received against the original bill.
• subordsTotal: number
  The total amount due for all subordinate accounts.
• totalDue: number
  The total amount due for the parent account and all child accounts.

{
    "required":[
        "creationDate"
    ],
    "type":"object",
    "properties":{
        "extension":{
            "type":"object",
            "description":"The extended attributes."
        },
        "invoiceFormat":{
            "type":"integer",
            "description":"The invoice format. Can be one of the following: <ul><li><b>1</b>: Detail</li><li><b>2</b>: Summary</li></ul>",
            "format":"int32"
        },
        "invoiceType":{
            "type":"integer",
            "description":"The invoice type. Can be one of the following: <ul><li><b>1</b>: Correction letter</li><li><b>2</b>: Replacement invoice</li></ul>",
            "format":"int32"
        },
        "adjusted":{
            "type":"number",
            "description":"The amount of any adjustments."
        },
        "billNo":{
            "type":"string",
            "description":"The bill number."
        },
        "creationDate":{
            "type":"string",
            "description":"The date and time the corrective bill was created.",
            "format":"date-time"
        },
        "disputed":{
            "type":"number",
            "description":"The amount of any disputes."
        },
        "currentTotal":{
            "type":"number",
            "description":"The current total amount due."
        },
        "arActionsAmtExcludingPayments":{
            "type":"number",
            "description":"The total amount of all accounts receivable actions, excluding any payments."
        },
        "due":{
            "type":"number",
            "description":"The amount due for the corrective bill."
        },
        "totalDue":{
            "type":"number",
            "description":"The total amount due for the parent account and all child accounts."
        },
        "subordsTotal":{
            "type":"number",
            "description":"The total amount due for all subordinate accounts."
        },
        "receivedForBill":{
            "type":"number",
            "description":"The payment received against the original bill."
        },
        "dueDate":{
            "type":"string",
            "description":"The date and time the corrective bill is due.",
            "format":"date-time"
        },
        "originalBill":{
            "$ref":"#/components/schemas/OriginalBill"
        }
    },
    "description":"Information about an original bill.",
    "xml":{
        "name":"originalBill"
    }
}

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."
}

Nested Schema : extension

Type: object

The extended attributes.

400 Response

The request isn't valid.

500 Response

An internal server error occurred.

Back to Top

Examples

This example shows how to get the corrective bill for a specified bill 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/bills/correctivebill/0.0.0.1+-bill+257531'

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,
   "invoiceFormat": 1,
   "invoiceType": 1,
   "adjusted": 0,
   "billNo": "CB1-1",
   "creationDate": 1612339502000,
   "disputed": 0,
   "currentTotal": 3,
   "arActionsAmtExcludingPayments": 0.00,
   "due": 52.95,
   "totalDue": 52.95,
   "subordsTotal": 49.95,
   "receivedForBill": 0,
   "dueDate": 1614931200000,
   "originalBill": {
      "extension": null,
      "invoiceFormat": null,
      "invoiceType": null,
      "adjusted": 0,
      "billNo": "B1-747",
      "creationDate": 1612290828000,
      "disputed": 0,
      "currentTotal": 3,
      "arActionsAmtExcludingPayments": 0.00,
      "due": 52.95,
      "totalDue": 52.95,
      "subordsTotal": 49.95,
      "receivedForBill": 0,
      "dueDate": 1613721600000,
      "originalBill": {
         "extension": null,
         "invoiceFormat": null,
         "invoiceType": null,
         "adjusted": null,
         "billNo": null,
         "creationDate": null,
         "disputed": null,
         "currentTotal": null,
         "arActionsAmtExcludingPayments": null,
         "due": null,
         "totalDue": null,
         "subordsTotal": null,
         "receivedForBill": null,
         "dueDate": null,
         "originalBill": null
      }
   },
   "notes":  {
      "extension": null,
      "id": "0.0.0.1+-note+263310",
      "accountId": "0.0.0.1+-account+149926",
      "amount": 0,
      "billUnitId": "0.0.0.1+-billinfo+148390",
      "billId": null,
      "closedDate": 1612339502000,
      "count": 1,
      "effectiveDate": 1612339502000,
      "eventId": "0.0.0.0++0",
      "header": "",
      "itemId": "0.0.0.0++0",
      "subType": 1001,
      "type": 1000,
      "domainId": 43,
      "reasonId": 2,
      "serviceId": "0.0.0.0++0",
      "status": 101,
      "comments": [
         {
            "csrLoginId": null,
            "csrFirstName": null,
            "csrLastName": null,
            "csrAccountId": null,
            "externalUser": "weblogic",
            "comment": "",
            "trackingId": "",
            "entryDate": 1612339502000
         }
      ]
   }
}

Back to Top