| Name | Description | Type | Additional information |
|---|---|---|---|
| AttachmentsInfo |
List of DisputeAttachmentInfoResponseModel |
Collection of DisputeAttachmentInfoResponseModel |
None. |
| BatchID | int? |
None. |
|
| BillerID | int |
None. |
|
| BillID | long? |
None. |
|
| CanAddProblemNoteOrAttchmt | boolean |
None. |
|
| CanCancel | boolean |
None. |
|
| CanDeleteAttachment | boolean |
None. |
|
| CanUpdate | boolean |
None. |
|
| ChangedByUserID | int? |
None. |
|
| CollectionProvider | CollectionProviders |
None. |
|
| CreatedByUserID | int? |
None. |
|
| CustomerID | int? |
None. |
|
| DisputedAmount |
Disputed Amount |
decimal |
Required |
| DisputedItems |
List of DisputeItemResponseModel. Conditionally required if DisputeType is 2 (By Line Item). |
Collection of DisputeItemResponseModel |
None. |
| DisputeExternalID |
External unique identifier of the Dispute. Required from API. |
string |
String length: inclusive between 0 and 100 |
| DisputeReasonCode |
Dispute Reason Code |
string |
Required |
| DisputeReasonDescription | string |
String length: inclusive between 0 and 50 |
|
| DisputeReasonInternal | boolean? |
None. |
|
| DisputeReasonToDisplay | string |
None. |
|
| DisputeRejectionReason | string |
String length: inclusive between 0 and 100 |
|
| DisputeRejectionReasonCategory | DisputeRejectionReasonCategories |
None. |
|
| DisputeStatus |
Dispute Status |
DisputeStatuses |
Required |
| DisputeType |
Dispute Type |
DisputeTypes |
Required |
| dtCancel |
Dispute Cancellation Date (when the dispute status is updated to Collectable or Canceled) |
date-time? |
None. |
| dtCreate |
Dispute Creation date time |
date-time |
None. |
| dtProcessed | date-time? |
None. |
|
| dtUpdate |
Internal update date time for the Dispute. Can be used for synchronization. |
date-time |
None. |
| dtUpdateExternal |
External update date time for the Dispute |
date-time? |
None. |
| ID |
Internal unique identifier of the Dispute |
long |
None. |
| Invoice |
Invoice data |
InvoiceModel |
None. |
| Oid |
Unique identifier of the Dispute. Conditionally required if ID and DisputeExternalID are not provided. |
globally unique identifier? |
None. |
| ProblemNotes |
List of DisputeProblemNoteResponseModel. Note: Not relevant for integration with GETPAID. |
Collection of DisputeProblemNoteResponseModel |
None. |
| ProcessingStatus | CollectionProcessingStatus |
None. |