Skip to content

Dispute Service

Swagger documentation: https://swagger-ui.aws-prod.billtrust.com/?urls.primaryName=Dispute%20Service%20v1

API Gateway Address: https://arc-aegis.billtrust.com/dispute

Dispute Overview

The Dispute Service is used to create, read, update, and delete information about disputes and dispute configuration.

Dispute Concepts

Dispute

A dispute represents a claim made by an account that part or all of the outstanding balance on an invoice should not be owed. Attributes of a dispute include

  • Dispute Code - The identifier for the dispute. Usually this will be in the format D-<document number>-## where ## is a 2 digit sequence starting at 01
  • Status - The dispute's status can be either Open (0) or Closed (1) or Cancel (2). A Closed dispute can be either Valid or Invalid and will have a Resolution and a Closed Date.
  • Document Number - Sometimes referred to as the Invoice Number, this represents the tenant's external identifier for the document being disputed.
  • PO Number - The purchase order associated with the document
  • Account Number - The tenant's external identifier for the account issuing the dispute.
  • Category - A grouping used for dispute reasons. These are usually broad ideas, such as Order Mistakes, Shipping Problems, and Pricing.
  • Reason - A specific reason for a dispute. Each reason belongs to a specific dispute category. An example would be a reason of 'Shipment Never Arrived' under the 'Shipping Problems' category.
  • Department - The department at your organization that will act on a dispute. Examples include Shipping or Accounts Payable.
  • Assignee - The person at your organization assigned to act on a dispute. This is generally an employee or contractor representing your organization, such as the CFO.
  • Resolution - An action that can be taken to resolve a dispute. Each resolution has a description of the resolution as well as a flag indicating that the resolution was done because the dispute was a valid dispute or not. This can include things like Coupon Issued, Replacement Sent, or Customer Paid.