NameDescriptionTypeAdditional information
AddedProblemNote

Only one new Problem note can be submitted per request. Note: Not relevant for integration with GETPAID.

DisputeProblemNoteModel

None.

AttachmentsToDelete

List of Dispute Attachments marked for deletion, with Status set to “Deleted” This list should be empty if there are no attachments to delete

Collection of DisputeAttachmentInfo

None.

BillerID

int

None.

BillID

long?

None.

CustomerID

int?

None.

DisputedAmount

Disputed Amount

decimal

Required

DisputedItems

List of DisputeItemModel. Conditionally required if DisputeType is 2 (By Line Item).

Collection of DisputeItemModel

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

DisputeStatus

Dispute Status

DisputeStatuses

Required

DisputeType

Dispute Type

DisputeTypes

Required

dtUpdateExternal

External update date time for the Dispute. Required from API. Can be used for synchronization.

date-time?

None.

ID

Internal unique identifier of the Dispute

long

None.

InvoiceLookup

Invoice identification data used to find Invoice associated with the Dispute

InvoiceLookupModel

None.

NewAttachments

Attachments to be added

Collection of DisputeAttachmentModel

None.

Oid

Unique identifier of the Dispute. Conditionally required if ID and DisputeExternalID are not provided.

globally unique identifier?

None.