Get Notes for a Transaction
get
/bcws/webresources/v1.0/notes/transaction/{id}
Retrieves the list of notes, along with their associated comments, for the specified transaction.
Request
Path Parameters
-
id(required): string
The transaction ID of the payment, such as T1,a,0.
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/xml
- application/json
200 Response
The notes were returned successfully.
Root 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 : 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 the notes for a transaction 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/notes/transaction/RG20200000009699'
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,
"id": "0.0.0.1+-note+123110",
"accountId": "0.0.0.1+-account+123217",
"amount": 0,
"billUnitId": "0.0.0.1+-billinfo+125265",
"billId": null,
"closedDate": 0,
"count": 3,
"effectiveDate": 1594713029000,
"eventId": "0.0.0.1+-event-billing-payment-wtransfer+32256",
"header": "",
"itemId": "0.0.0.1+-item-payment+119786",
"subType": 802,
"type": 800,
"domainId": 14,
"reasonId": 0,
"serviceId": "0.0.0.1+-service-email+180304",
"status": 102,
"comments": [
{
"csrLoginId": "HeadCSR",
"csrFirstName": "Alia",
"csrLastName": "Abadi",
"csrAccountId": "1234"
"externalUser": "CSR Portal",
"comment": "Initial purchase.",
"trackingId": "",
"entryDate": 1596192743000
},
{
"csrLoginId": "HeadCSR",
"csrFirstName": "Alia",
"csrLastName": "Abadi",
"csrAccountId": "1234"
"externalUser": "CSR Portal",
"comment": "Customer will confirm with bank.",
"trackingId": "",
"entryDate": 1602422305000
}
]
},
{
"extension": null,
"id": "0.0.0.1+-note+257803",
"accountId": "0.0.0.1+-account+123217",
"amount": 0,
"billUnitId": "0.0.0.0++0",
"billId": null,
"closedDate": 0,
"count": 1,
"effectiveDate": 1611765465000,
"eventId": "0.0.0.1+-event-billing-payment-wtransfer+32257",
"header": "",
"itemId": "0.0.0.1+-item-payment+119786",
"subType": 801,
"type": 800,
"domainId": 0,
"reasonId": 0,
"serviceId": "0.0.0.0++0",
"status": 102,
"comments": [
{
"csrLoginId": "HeadCSR",
"csrFirstName": "Alia",
"csrLastName": "Abadi",
"csrAccountId": "1234",
"externalUser": "CSR Portal",
"comment": "Payment did not go through, reversing.",
"trackingId": "",
"entryDate": 1611765465000
}
]
}
]