Get Settlement Details for a Dispute
get
/bcws/webresources/v1.0/disputes/settlement/{id}
Gets settlement details of a dispute
Request
Path Parameters
-
id(required): string
The settlement ID or dispute ID.
Query Parameters
-
accountId(required): string
The account ID. This parameter is optional.
-
billId(required): string
The bill ID. This parameter is optional.
-
billunitId(required): string
The bill unit ID. This parameter is optional.
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/xml
- application/json
200 Response
The settlement details were returned successfully.
Root Schema : settlementDetails
Type:
Show Source
object
-
billId(required): string
The ID of the bill associated with the settlement.
-
billingEnd: string
(date-time)
The date and time the billing cycle ends.
-
billingStart: string
(date-time)
The date and time the billing cycle starts.
-
billNumber: string
The bill number associated with the settlement.
-
disputedAmount(required): number
The amount of the dispute.
-
disputedDate(required): string
(date-time)
The date and time the bill, item, or event was disputed.
-
disputeId(required): string
The ID of the dispute.
-
disputeRef: object
ResourceRef
-
due: number
The amount due after the settlement.
-
eventsCount(required): string
The number of events associated with the settlement.
-
extension: object
extension
The extended attributes.
-
itemId(required): string
The ID of the item associated with the settlement.
-
itemName(required): string
The name of the item associated with the settlement.
-
itemNumber(required): string
The item number associated with the settlement.
-
notes: object
Notes
-
settledDate(required): string
(date-time)
The date and time the dispute was settled.
-
settlementAmount(required): number
The settlement amount. The amount you enter can be all, a portion, or none of the disputed amount.
-
settlementId(required): string
The ID of the settlement.
-
settlementRef: object
ResourceRef
Nested Schema : ResourceRef
Type:
Show Source
object
-
id(required): string
The ID.
-
uri: string
The Uniform Resource Identifier (URI) associated with the resource.
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 : 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 settlement details for a dispute 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/disputes/settlement/0.0.0.1+-item-settlement+271994'
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,
"billId": "0.0.0.1+-bill+274419",
"itemId": "0.0.0.1+-item-cycle_forward+268139",
"disputedDate": 1613069511000,
"settledDate": 1613069511000,
"disputeId": "D1-119",
"disputeRef": {
"id": "0.0.0.1+-item-dispute+274536",
"uri": null
},
"settlementId": "S1-4",
"itemName": "Cycle forward",
"itemNumber": "B1-3442,3",
"eventsCount": null,
"disputedAmount": 3,
"settlementAmount": 3,
"settlementRef": {
"id": "0.0.0.1+-item-settlement+271994",
"uri": null
},
"billNumber": "B1-3442",
"due": 37.43,
"billingStart": 1612339200000,
"billingEnd": 1612341616000,
"notes": {
"extension": null,
"id": "0.0.0.1+-note+277096",
"accountId": "0.0.0.1+-account+266347",
"amount": -3,
"billUnitId": "0.0.0.1+-billinfo+269419",
"billId": null,
"closedDate": 1613069511000,
"count": 1,
"effectiveDate": 1613069511000,
"eventId": "0.0.0.0++0",
"header": "",
"itemId": "0.0.0.1+-item-settlement+271994",
"subType": 209,
"type": 200,
"domainId": 26,
"reasonId": 1,
"serviceId": "0.0.0.0++0",
"status": 101,
"comments": [
{
"csrLoginId": "csr_login",
"csrFirstName": "Jill",
"csrLastName": "Williams",
"csrAccountId": "account_id",
"externalUser": "user",
"comment": "Sample settlement details.",
"trackingId": "",
"entryDate": 1613069511000
}
]
}
}