Create an Event Dispute
post
/bcws/webresources/v1.0/disputes/event
Creates an event dispute.
Request
There are no request parameters for this operation.
Supported Media Types
- application/xml
- application/json
Information about the event dispute.
Root Schema : schema
Type:
Show Source
object
-
accountRef: object
ResourceRef
-
actionAffectsRef: object
ResourceRef
-
amount(required): number
The amount of the adjustment.
-
amountIsCredit: boolean
Default Value:
true
Whether the adjustment is a credit (true) or a debit (false). -
appliesToTotalOfAllEvents: boolean
Default Value:
true
Whether the adjustment applies to the total from all events (true) or not (false). -
billItem: array
billItem
The bill item details.
-
effective: string
(date-time)
The date and time the adjustment takes effect.
-
events: object
Events
The events.
-
extension: object
extension
The extended attributes.
-
includeTax: boolean
Default Value:
true
Whether to include the tax in the adjustment (true) or not (false). -
notes: object
Notes
-
percent: number
The amount of the adjustment, as a percentage. For example, enter 5 for 5%.
-
resourceId: integer
(int32)
The ID of the resource to adjust.
-
taxType: integer
(int32)
Whether to include tax in the adjustment (8), exclude the tax and adjust only the amount (9), or adjust only the tax (10).
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 : billItem
Type:
array
The bill item details.
Show Source
-
Array of:
object billItem
The bill item details.
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 : billItem
Type:
object
The bill item details.
Show Source
-
accountName: string
The name of the account.
-
accountNumber: string
The account number associated with the bill item.
-
accountRef: object
ResourceRef
-
adjusted: number
The total amount from debit and credit adjustments made to the bill item.
-
aliasList: array
aliasList
The list of aliases in the bill item.
-
amount(required): number
The amount of the bill item.
-
arBillinfoRef: object
ResourceRef
-
arBillRef: object
ResourceRef
-
billInfoId: string
The ID of the /billinfo object.
-
billinfoRef: object
ResourceRef
-
billNo: string
The bill number.
-
billRef: object
ResourceRef
-
closedDate: string
(date-time)
The date and time the bill item was closed. If the bill item is reopened for an adjustment, this is reset until the bill item is closed again.
-
creationDate: string
(date-time)
The date and time the bill item was created.
-
currency: integer
(int32)
The currency for the bill item, copied from the currency of the associated account.
-
deltaDue: number
The delta amount due.
-
discount: number
The amount discounted for the bill item.
-
disputed: number
The total amount from disputes associated with the bill item.
-
due: number
The amount due for the bill item.
-
dueDate: string
(date-time)
The date when the amount in the bill item is due.
-
extension: object
extension
The extended attributes.
-
firstName: string
The first name of the account holder.
-
id(required): string
The ID.
-
itemNo: string
The bill item's number.
-
lastName: string
The last name of the account holder.
-
login: string
The username associated with the bill item.
-
name: string
The bill item's name.
-
received: number
The amount of payments or credits applied to the bill item.
-
serviceRef: object
ResourceRef
-
serviceTypeName: string
The name of the service type.
-
status: string
The status of the bill item: active (10100), inactive (10102), or closed (10103)
-
transfered: number
The amount transferred out of the bill item.
-
type: string
The bill item's type.
-
writeoff: number
The amount written off for the bill item.
Nested Schema : aliasList
Type:
array
The list of aliases in the bill item.
Show Source
-
Array of:
object AliasList
The list of aliases associated with the service.
Nested Schema : extension
Type:
object
The extended attributes.
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.
Information about the event dispute.
Root Schema : schema
Type:
Show Source
object
-
accountRef: object
ResourceRef
-
actionAffectsRef: object
ResourceRef
-
amount(required): number
The amount of the adjustment.
-
amountIsCredit: boolean
Default Value:
true
Whether the adjustment is a credit (true) or a debit (false). -
appliesToTotalOfAllEvents: boolean
Default Value:
true
Whether the adjustment applies to the total from all events (true) or not (false). -
billItem: array
billItem
The bill item details.
-
effective: string
(date-time)
The date and time the adjustment takes effect.
-
events: object
Events
The events.
-
extension: object
extension
The extended attributes.
-
includeTax: boolean
Default Value:
true
Whether to include the tax in the adjustment (true) or not (false). -
notes: object
Notes
-
percent: number
The amount of the adjustment, as a percentage. For example, enter 5 for 5%.
-
resourceId: integer
(int32)
The ID of the resource to adjust.
-
taxType: integer
(int32)
Whether to include tax in the adjustment (8), exclude the tax and adjust only the amount (9), or adjust only the tax (10).
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 : billItem
Type:
array
The bill item details.
Show Source
-
Array of:
object billItem
The bill item details.
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 : billItem
Type:
object
The bill item details.
Show Source
-
accountName: string
The name of the account.
-
accountNumber: string
The account number associated with the bill item.
-
accountRef: object
ResourceRef
-
adjusted: number
The total amount from debit and credit adjustments made to the bill item.
-
aliasList: array
aliasList
The list of aliases in the bill item.
-
amount(required): number
The amount of the bill item.
-
arBillinfoRef: object
ResourceRef
-
arBillRef: object
ResourceRef
-
billInfoId: string
The ID of the /billinfo object.
-
billinfoRef: object
ResourceRef
-
billNo: string
The bill number.
-
billRef: object
ResourceRef
-
closedDate: string
(date-time)
The date and time the bill item was closed. If the bill item is reopened for an adjustment, this is reset until the bill item is closed again.
-
creationDate: string
(date-time)
The date and time the bill item was created.
-
currency: integer
(int32)
The currency for the bill item, copied from the currency of the associated account.
-
deltaDue: number
The delta amount due.
-
discount: number
The amount discounted for the bill item.
-
disputed: number
The total amount from disputes associated with the bill item.
-
due: number
The amount due for the bill item.
-
dueDate: string
(date-time)
The date when the amount in the bill item is due.
-
extension: object
extension
The extended attributes.
-
firstName: string
The first name of the account holder.
-
id(required): string
The ID.
-
itemNo: string
The bill item's number.
-
lastName: string
The last name of the account holder.
-
login: string
The username associated with the bill item.
-
name: string
The bill item's name.
-
received: number
The amount of payments or credits applied to the bill item.
-
serviceRef: object
ResourceRef
-
serviceTypeName: string
The name of the service type.
-
status: string
The status of the bill item: active (10100), inactive (10102), or closed (10103)
-
transfered: number
The amount transferred out of the bill item.
-
type: string
The bill item's type.
-
writeoff: number
The amount written off for the bill item.
Nested Schema : aliasList
Type:
array
The list of aliases in the bill item.
Show Source
-
Array of:
object AliasList
The list of aliases associated with the service.
Nested Schema : extension
Type:
object
The extended attributes.
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
201 Response
The event dispute was created successfully.
400 Response
The request isn't valid.
500 Response
An internal server error occurred.