Get Details about an Adjustment
get
/bcws/webresources/v1.0/adjustments/{id}
Gets the details about the adjustment that matches the specified ID.
Request
Path Parameters
-
id(required): string
The ID of the adjustment, such as 0.0.0.1+-item-adjustment+73707.
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/xml
- application/json
200 Response
The adjustment details were returned successfully.
Root Schema : adjustmentDetails
Type:
Show Source
object
-
accountId(required): string
The ID of the account associated with the adjustment.
-
adjustmentId: string
The adjustment's ID.
-
allocatedAmount: number
The amount of the adjustment that has been allocated.
-
billDetails: array
billDetails
-
effectiveDate(required): string
(date-time)
The date and time the adjustment takes effect.
-
extension: object
extension
The extended attributes.
-
notes: object
Notes
-
originalAdjustmentAmount: number
The original amount before the adjustment.
-
taxAmount: number
The amount of tax associated with the adjustment.
-
unallocatedAmount: number
The amount of the adjustment that has not been allocated.
Nested Schema : billDetails
Type:
Show Source
array
-
Array of:
object BillDetails
The list of bill details associated with the payment.
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 : BillDetails
Type:
object
The list of bill details associated with the payment.
Show Source
-
accountNumber(required): string
The account number associated with the bill.
-
billId(required): string
The bill ID.
-
billUnitId(required): string
The ID for the bill unit associated with the bill.
-
cycleEnds: string
(date-time)
The date and time the billing cycle ends.
-
cycleStarts: string
(date-time)
The date and time the billing cycle starts.
-
dueAmount(required): number
The total amount due.
-
dueDate(required): string
(date-time)
The due date for the bill.
-
itemsAffected: array
itemsAffected
Affected bill items.
-
itemsAffectedCount: integer
(int64)
The number of bill items affected by the bill.
Nested Schema : itemsAffected
Type:
array
Affected bill items.
Show Source
-
Array of:
object ItemsAffected
Affected bill items.
Nested Schema : ItemsAffected
Type:
object
Affected bill items.
Show Source
-
accountNumber(required): string
The account number associated with the bill item.
-
amount(required): number
The bill item amount.
-
billNumber(required): string
The bill number associated with the bill item.
-
billUnitId(required): string
The ID of the bill unit associated with the bill item.
-
cycleEnds: string
(date-time)
The date and time the billing cycle ends.
-
cycleStarts: string
(date-time)
The date and time the billing cycle starts.
-
item(required): string
The bill item.
-
settledNonTaxedAmount(required): number
The nontaxable amount for the bill item settled by the payment.
-
settledTaxAmount(required): number
The amount of tax for the bill item settled by the payment.
-
settledTaxedAmount(required): number
The taxable amount for the bill item settled by the payment.
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 details about a specified adjustment 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/adjustments/0.0.0.1+-item-adjustment+73707'
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,
"effectiveDate": 1589452345000,
"adjustmentId": "A1-4",
"originalAdjustmentAmount": -100,
"allocatedAmount": -100,
"unallocatedAmount": 0,
"taxAmount": 0,
"notes": {
"extension": null,
"id": "0.0.0.1+-note+70683",
"accountId": "0.0.0.1+-account+57615",
"amount": -100,
"billUnitId": "0.0.0.1+-billinfo+60687",
"billId": null,
"closedDate": 1589452347000,
"count": 1,
"effectiveDate": 1589452347000,
"eventId": "0.0.0.0++0",
"header": "",
"itemId": "0.0.0.1+-item-adjustment+73707",
"subType": 201,
"type": 200,
"domainId": 8,
"reasonId": 2,
"serviceId": "0.0.0.0++0",
"status": 101,
"comments": [
{
"csrLoginId": null,
"csrFirstName": "Adam",
"csrLastName": "Rodriguez",
"csrAccountId": "0.0.0.1-39485",
"externalUser": "user",
"comment": "Customer credited for service outage.",
"trackingId": "",
"entryDate": 1589452347000
}
]
},
"accountId": "0.0.0.1+-account+57615",
"billDetails": [
{
"billId": "B1-1",
"cycleStarts": 1589180400000,
"cycleEnds": 1589446645000,
"dueAmount": -100,
"dueDate": 1590641967000,
"eventsAffectedCount": 0,
"itemsAffectedCount": 1,
"itemsAffected": [
{
"accountNumber": "0.0.0.1-57615",
"billNumber": "B1-1",
"amount": -100,
"item": "Cycle forward,B1-1,3",
"billUnitName": "Bill Unit(1)",
"cycleStarts": 1589180400000,
"cycleEnds": 1589446645000,
"settledTaxAmount": 10,
"settledTaxedAmount": 100,
"settledNonTaxedAmount": 0
}
]
}
]
}