Get Collections and Aging Buckets for an Account
get
/bcws/webresources/v1.0/collections/account/{id}
Gets collections details, including information about aging buckets, for the specified account ID.
Request
Path Parameters
-
id(required): string
The ID of the account, such as 0.0.0.1+-account+123123, to get collections details for.
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/xml
- application/json
200 Response
The collections and aging bucket details were returned successfully.
Root Schema : collectionDetails
Type:
Show Source
object
-
actions: array
actions
List of collections actions.
-
agingBuckets: array
agingBuckets
List of aging buckets.
-
billUnitId(required): string
The ID of the bill unit.
-
extension: object
extension
The extended attributes.
-
minimumDue(required): number
The minimum payment amount.
-
notes: object
Notes
-
overdueAmount(required): number
The amount that is past due.
-
overdueDays: integer
(int32)
The number of days that the payment is past due.
-
scenarioId(required): string
The ID of the collections scenario.
Nested Schema : actions
Type:
array
List of collections actions.
Show Source
-
Array of:
object Actions
List of collections actions.
Nested Schema : agingBuckets
Type:
array
List of aging buckets.
Show Source
-
Array of:
object AgingBuckets
List of aging buckets.
Nested Schema : extension
Type:
object
The extended attributes.
Nested Schema : Notes
Type:
Show Source
object
-
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.
Nested Schema : Actions
Type:
object
List of collections actions.
Show Source
-
action(required): string
The collections action's name.
-
actionId(required): string
The ID of the collections action.
-
completedDate(required): string
(date-time)
The date and time the collections action was completed.
-
dueDate(required): string
(date-time)
The date and time the collections action is due.
-
status: integer
(int32)
The status of the collections action: 0 (Pending) , 1 (Canceled), 2 (Completed), 3 (Error), and 4 (No execute).
Nested Schema : AgingBuckets
Type:
object
List of aging buckets.
Show Source
-
days: integer
(int32)
The number of overdue days in this aging bucket.
-
due(required): number
The amount due in this aging bucket.
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.
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.
500 Response
An internal server error occurred.
Examples
This example shows how to get collections and aging bucket 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/account/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,
"scenarioId": "0.0.0.1+-collections_scenario+268210",
"billUnitId": "0.0.0.1+-billinfo+128084",
"overdueAmount": 7413.52,
"overdueDays": 27,
"minimumDue": 7403.52,
"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
}
]
},
"agingBuckets": [
{
"days": 2,
"due": 0
},
{
"days": 0,
"due": 7413.52
}
],
"actions": [
{
"actionId": "0.0.0.1+-collections_action-inactivate_billinfo+270258",
"action": "Inactivate Services of Billinfo",
"dueDate": 1610697600000,
"completedDate": null,
"status": 1
},
{
"actionId": "0.0.0.1+-collections_action-late_fee+268402",
"action": "Move to collections",
"dueDate": 1610956800000,
"completedDate": null,
"status": 1
},
{
"actionId": "0.0.0.1+-collections_action-promise_to_pay+278557",
"action": "Promise to Pay",
"dueDate": 1612944000000,
"completedDate": null,
"status": 1
}
]
}
]