Jump to

• Request
• Response
• Examples

Get Collections Details for an Account

get

/bcws/webresources/v1.0/collections/details/{id}

Gets the collections details for all bill units that are in collections for the specified account ID.

Request

Path Parameters

• id(required): string
  The ID for the account, such as 0.0.0.1+-account+123123.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/xml
• application/json

200 Response

The collections details were returned successfully.

Body ()

Root Schema : accountCollectionDetails

Type: object

Show Source

• accountId(required): string
  The account's ID.
• accountNumber(required): string
  The account's number.
• address(required): string
  The account's address.
• billUnitCollectionsDetails: array billUnitCollectionsDetails
  The details for a bill unit in collections.
• city(required): string
  The account's city.
• company: string
  The account's company name.
• country(required): string
  The account's country.
• emailAddress: string
  The account's email address.
• extension: object extension
  The extended attributes.
• firstName(required): string
  The account owner's first name.
• lastName(required): string
  The account owner's last name.
• numberOfBillUnitsInCollections: integer (int32)
  The number of bill units that are in collections.
• phonenumbers: array phonenumbers
  The list of the account's phone numbers.
• state: string
  The account's state or province.
• zip: string
  The account's ZIP or postal code.

{
    "required":[
        "accountId",
        "accountNumber",
        "address",
        "city",
        "country",
        "firstName",
        "lastName"
    ],
    "type":"object",
    "properties":{
        "extension":{
            "type":"object",
            "description":"The extended attributes."
        },
        "billUnitCollectionsDetails":{
            "type":"array",
            "description":"The details for a bill unit in collections.",
            "items":{
                "$ref":"#/components/schemas/BillUnitCollectionsDetails"
            }
        },
        "accountNumber":{
            "type":"string",
            "description":"The account's number."
        },
        "accountId":{
            "type":"string",
            "description":"The account's ID."
        },
        "numberOfBillUnitsInCollections":{
            "type":"integer",
            "description":"The number of bill units that are in collections.",
            "format":"int32"
        },
        "firstName":{
            "type":"string",
            "description":"The account owner's first name."
        },
        "lastName":{
            "type":"string",
            "description":"The account owner's last name."
        },
        "address":{
            "type":"string",
            "description":"The account's address."
        },
        "city":{
            "type":"string",
            "description":"The account's city."
        },
        "company":{
            "type":"string",
            "description":"The account's company name."
        },
        "country":{
            "type":"string",
            "description":"The account's country."
        },
        "emailAddress":{
            "type":"string",
            "description":"The account's email address."
        },
        "state":{
            "type":"string",
            "description":"The account's state or province."
        },
        "zip":{
            "type":"string",
            "description":"The account's ZIP or postal code."
        },
        "phonenumbers":{
            "type":"array",
            "description":"The list of the account's phone numbers.",
            "items":{
                "$ref":"#/components/schemas/Phonenumbers"
            }
        }
    },
    "xml":{
        "name":"accountCollectionDetails"
    }
}

Nested Schema : billUnitCollectionsDetails

Type: array

The details for a bill unit in collections.

Show Source

• Array of: object BillUnitCollectionsDetails
  The details for a bill unit in collections.

{
    "type":"array",
    "description":"The details for a bill unit in collections.",
    "items":{
        "$ref":"#/components/schemas/BillUnitCollectionsDetails"
    }
}

Nested Schema : extension

Type: object

The extended attributes.

Nested Schema : phonenumbers

Type: array

The list of the account's phone numbers.

Show Source

• Array of: object Phonenumbers
  The list of the account's phone numbers.

{
    "type":"array",
    "description":"The list of the account's phone numbers.",
    "items":{
        "$ref":"#/components/schemas/Phonenumbers"
    }
}

Nested Schema : BillUnitCollectionsDetails

Type: object

The details for a bill unit in collections.

Show Source

• billUnitId(required): string
  The ID of the bill unit in collections.
• billUnitName(required): string
  The name of the bill unit in collections.
• collectionAgent(required): string
  The collections agent assigned to the account.
• collectionsActions: array CollectionsActions
  The list of collections actions for the account.
• collectionsGroupId(required): string
  The ID of the account's collections group.
• currency: integer (int32)
  The code for the account's primary currency.
• entryDate(required): string (date-time)
  The date and time the account entered collections.
• lastPaymentAmount(required): number
  The amount of the account's last payment.
• lastPaymentEffectiveDate(required): string (date-time)
  The effective date and time of the account's last payment.
• lastPaymentId(required): string
  The ID of the account's last payment.
• minimumPayment(required): number
  The minimum required payment.
• notes: object Notes
• numberOfTimesInCollections: integer (int32)
  The number of times the account has been in collections.
• overdueAmount(required): number
  The amount that is overdue.
• overdueDays: integer (int32)
  The number of days the payment is overdue.
• promiseToPayStatus: integer (int32)
  The status of Promise to Pay in the collection scenario.
• scenarioId(required): string
  The ID of the account's collections scenario.
• scenarioName(required): string
  The name of the account's collections scenario.

{
    "required":[
        "billUnitId",
        "billUnitName",
        "collectionAgent",
        "collectionsGroupId",
        "entryDate",
        "lastPaymentAmount",
        "lastPaymentEffectiveDate",
        "lastPaymentId",
        "minimumPayment",
        "overdueAmount",
        "scenarioId",
        "scenarioName"
    ],
    "type":"object",
    "properties":{
        "scenarioId":{
            "type":"string",
            "description":"The ID of the account's collections scenario."
        },
        "billUnitId":{
            "type":"string",
            "description":"The ID of the bill unit in collections."
        },
        "billUnitName":{
            "type":"string",
            "description":"The name of the bill unit in collections."
        },
        "overdueAmount":{
            "type":"number",
            "description":"The amount that is overdue."
        },
        "minimumPayment":{
            "type":"number",
            "description":"The minimum required payment."
        },
        "overdueDays":{
            "type":"integer",
            "description":"The number of days the payment is overdue.",
            "format":"int32"
        },
        "entryDate":{
            "type":"string",
            "description":"The date and time the account entered collections.",
            "format":"date-time"
        },
        "lastPaymentId":{
            "type":"string",
            "description":"The ID of the account's last payment."
        },
        "lastPaymentAmount":{
            "type":"number",
            "description":"The amount of the account's last payment."
        },
        "lastPaymentEffectiveDate":{
            "type":"string",
            "description":"The effective date and time of the account's last payment.",
            "format":"date-time"
        },
        "currency":{
            "type":"integer",
            "description":"The code for the account's primary currency.",
            "format":"int32"
        },
        "collectionAgent":{
            "type":"string",
            "description":"The collections agent assigned to the account."
        },
        "scenarioName":{
            "type":"string",
            "description":"The name of the account's collections scenario."
        },
        "notes":{
            "$ref":"#/components/schemas/Notes"
        },
        "numberOfTimesInCollections":{
            "type":"integer",
            "description":"The number of times the account has been in collections.",
            "format":"int32"
        },
        "collectionsGroupId":{
            "type":"string",
            "description":"The ID of the account's collections group."
        },
        "promiseToPayStatus":{
            "type":"integer",
            "description":"The status of Promise to Pay in the collection scenario.",
            "format":"int32"
        },
        "collectionsActions":{
            "type":"array",
            "description":"The list of collections actions for the account.",
            "xml":{
                "name":"CollectionsActions"
            },
            "items":{
                "$ref":"#/components/schemas/CollectionsActions"
            }
        }
    },
    "description":"The details for a bill unit in collections."
}

Nested Schema : CollectionsActions

Type: array

The list of collections actions for the account.

Show Source

• Array of: object CollectionsActions
  The list of collections actions for the account.

{
    "type":"array",
    "description":"The list of collections actions for the account.",
    "xml":{
        "name":"CollectionsActions"
    },
    "items":{
        "$ref":"#/components/schemas/CollectionsActions"
    }
}

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

Type: object

The list of collections actions for the account.

Show Source

• action(required): string
  The collections action's name.
• actionId(required): string
  The collections action's ID.
• amount: number
  The collections action amount.
• completedDate(required): string (date-time)
  The date and time the collections action was completed.
• configCollectionsId(required): string
  The collections action's configuration ID.
• dueDate(required): string (date-time)
  The date and time the collections action is due.
• status: integer (int32)
  The collections action's status. Can be one of the following:

  • 0: Pending
  • 1: Canceled
  • 2: Completed
  • 3: Error
  • 4: Did not run.
  • 5: Waiting for a dependent

{
    "required":[
        "action",
        "actionId",
        "completedDate",
        "configCollectionsId",
        "dueDate"
    ],
    "type":"object",
    "properties":{
        "action":{
            "type":"string",
            "description":"The collections action's name."
        },
        "actionId":{
            "type":"string",
            "description":"The collections action's ID."
        },
        "dueDate":{
            "type":"string",
            "description":"The date and time the collections action is due.",
            "format":"date-time"
        },
        "completedDate":{
            "type":"string",
            "description":"The date and time the collections action was completed.",
            "format":"date-time"
        },
        "amount":{
            "type":"number",
            "description":"The collections action amount."
        },
        "configCollectionsId":{
            "type":"string",
            "description":"The collections action's configuration ID."
        },
        "status":{
            "type":"integer",
            "description":"The collections action's status. Can be one of the following:<ul><li><b>0</b>: Pending</li><li><b>1</b>: Canceled</li><li><b>2</b>: Completed</li><li><b>3</b>: Error</li><li><b>4</b>: Did not run.<li><b>5</b>: Waiting for a dependent</li></ul> </li>",
            "format":"int32"
        }
    },
    "description":"The list of collections actions for the account."
}

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

Type: object

The list of the account's phone numbers.

Show Source

• number(required): string
  The phone number.
• phonetype: integer (int32)
  The phone number's type.

{
    "required":[
        "number"
    ],
    "type":"object",
    "properties":{
        "number":{
            "type":"string",
            "description":"The phone number."
        },
        "phonetype":{
            "type":"integer",
            "description":"The phone number's type.",
            "format":"int32"
        }
    },
    "description":"The list of the account's phone numbers."
}

500 Response

An internal server error occurred.

Back to Top

Examples

This example shows how to get collections details for an account 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/collections/details/0.0.0.1+-account+130964'

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,
    "billUnitCollectionsDetails": [
        {
            "scenarioId": "0.0.0.1+-collections_scenario+268210",
            "billUnitId": "0.0.0.1+-billinfo+128084",
            "billUnitName": "Bill Unit(1)",
            "overdueAmount": 7413.52,
            "minimumPayment": 7403.52,
            "overdueDays": 27,
            "entryDate": 1610611200000,
            "lastPaymentId": null,
            "lastPaymentAmount": null,
            "lastPaymentEffectiveDate": null,
            "currency": 840,
            "collectionAgent": "",
            "scenarioName": "tenDaysOverdue",
            "notes": {
                "extension": null,
                "id": "0.0.0.1+-note+278620",
                "accountId": "0.0.0.1+-account+130964",
                "amount": 0,
                "billUnitId": "0.0.0.1+-billinfo+128084",
                "billId": null,
                "closedDate": 1612862929000,
                "count": 3,
                "effectiveDate": 1612791116000,
                "eventId": "0.0.0.0++0",
                "header": "",
                "itemId": "0.0.0.0++0",
                "subType": 901,
                "type": 900,
                "domainId": 10,
                "reasonId": 3,
                "serviceId": "0.0.0.0++0",
                "status": 101,
                "comments": [
                    {
                        "csrLoginId": "HeadCSR",
                        "csrFirstName": "Alia",
                        "csrLastName": "Abadi",
                        "csrAccountId": "1234",
                        "externalUser": "CSRPortal",
                        "comment": "Inactivating customer's services.",
                        "trackingId": "",
                        "entryDate": 1612791116000
                    },
                    {
                        "csrLoginId": "HeadCSR",
                        "csrFirstName": "Alia",
                        "csrLastName": "Abadi",
                        "csrAccountId": "1234",
                        "externalUser": "CSRPortal",
                        "comment": "Bill unit moved to collections.",
                        "trackingId": "",
                        "entryDate": 1612791223000
                    },
                    {
                        "csrLoginId": "HeadCSR",
                        "csrFirstName": "Alia",
                        "csrLastName": "Abadi",
                        "csrAccountId": "1234",
                        "externalUser": "CSRPortal",
                        "comment": "Customer promised to pay by specified date.",
                        "trackingId": "",
                        "entryDate": 1612792466000
                    }
                ]
            },
            "numberOfTimesInCollections": 2,
            "collectionsGroupId": null,
            "collectionsActions": [
                {
                    "action": "Inactivate Services of Billinfo",
                    "actionId": "0.0.0.1+-collections_action-inactivate_billinfo+270258",
                    "dueDate": 1610697600000,
                    "completedDate": 0,
                    "amount": null,
                    "configCollectionsId": "0.0.0.1+-config-collections-action+823",
                    "status": 1
                },
                {
                    "action": "Move to collections",
                    "actionId": "0.0.0.1+-collections_action-late_fee+268402",
                    "dueDate": 1610956800000,
                    "completedDate": 0,
                    "amount": null,
                    "configCollectionsId": "0.0.0.1+-config-collections-action-custom-late_fee+125732",
                    "status": 1
                },
                {
                    "action": "Promise to Pay",
                    "actionId": "0.0.0.1+-collections_action-promise_to_pay+278557",
                    "dueDate": 1612944000000,
                    "completedDate": 0,
                    "amount": 618,
                    "configCollectionsId": "0.0.0.1+-config-collections-action+825",
                    "status": 1
                }
            ]
        }
    ],
    "accountNumber": "0.0.0.1-130964",
    "accountId": "0.0.0.1+-account+130964",
    "numberOfBillUnitsInCollections": 1,
    "firstName": "Casey",
    "lastName": "Jones",
    "address": "111 West Jackson Boulevard",
    "city": "Chicago",
    "company": "",
    "country": "US",
    "emailAddress": "",
    "state": "IL",
    "zip": "60604",
    "phonenumbers": []
}

Back to Top