Adjust a Noncurrency Balance
post
/bcws/webresources/v1.0/adjustments/noncurrency
Adjusts the specified noncurrency balance.
Request
There are no request parameters for this operation.
Supported Media Types
- application/xml
- application/json
Details about the adjustment. The minimum required parameters are:
- accountRef
- id
- amount
- balanceGroupRef
- id
- validFrom
- validTo
Root Schema : schema
Type:
Show Source
object
-
accountRef: object
ResourceRef
-
actionAffectsRef: object
ResourceRef
-
amount(required): number
The amount of the adjustment.
-
balanceGroupRef: object
ResourceRef
-
effective: string
(date-time)
The date and time the adjustment takes effect.
-
extension: object
extension
The extended attributes.
-
notes: object
Notes
-
resourceId: integer
(int32)
The resource ID of the noncurrency balance to adjust.
-
validFrom(required): string
(date-time)
The date and time the adjustment's validity period starts.
-
validTo(required): string
(date-time)
The date and time the adjustment's validity period ends.
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.
Details about the adjustment. The minimum required parameters are:
- accountRef
- id
- amount
- balanceGroupRef
- id
- validFrom
- validTo
Root Schema : schema
Type:
Show Source
object
-
accountRef: object
ResourceRef
-
actionAffectsRef: object
ResourceRef
-
amount(required): number
The amount of the adjustment.
-
balanceGroupRef: object
ResourceRef
-
effective: string
(date-time)
The date and time the adjustment takes effect.
-
extension: object
extension
The extended attributes.
-
notes: object
Notes
-
resourceId: integer
(int32)
The resource ID of the noncurrency balance to adjust.
-
validFrom(required): string
(date-time)
The date and time the adjustment's validity period starts.
-
validTo(required): string
(date-time)
The date and time the adjustment's validity period ends.
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.
Response
Supported Media Types
- */*
200 Response
The noncurrency balance was adjusted successfully.
Root Schema : resource
Type:
Show Source
object
-
extension: object
extension
The extended attributes.
-
reference(required): object
ResourceRef
Nested Schema : extension
Type:
object
The extended attributes.
Nested Schema : ResourceRef
Type:
Show Source
object
-
id(required): string
The ID.
-
uri: string
The Uniform Resource Identifier (URI) associated with the resource.
500 Response
An internal server error occurred.
Examples
This example shows how to adjust a noncurrency balance by submitting a PUT request on the REST resource using cURL. For more information about cURL, see "Use cURL".
cURL Command
curl -X PUT 'http://hostname:port/bcws/webresources/v1.0/adjustments/noncurrency' -H 'content-type: application/json' -d @adjust.json
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.
- adjust.json is the JSON file that specifies the adjustment to make.
Example of Request Body
This example shows the contents of the adjust.json file sent as the request body.
{
"amount": "1",
"resourceId": 1000100,
"accountRef": {
"id": "0.0.0.1+-account+85712"
},
"balanceGroupRef": {
"id": "0.0.0.1+-balance_group+141292"
},
"validTo": "0",
"validFrom": "2021-02-08T18:58:11.174Z",
"notes": {
"amount": -1,
"domainId": 21,
"accountId": "0.0.0.1+-account+85712",
"billUnitId": "0.0.0.1+-billinfo+148374",
"reasonId": "1",
"status": 101,
"comments": [
{
"comment":"A sample comment."
}
]
}
}
Example of Response Body
This example shows the contents of the response body in JSON format.
{
"extension": null,
"reference": {
"id": "0.0.0.1+-event-billing-debit+328358152519303660",
"uri": "http://hostname:port/bc/webresources/v1.0/adjustments/0.0.0.1+-event-billing-debit+328358152519303660"
}
}