List Disputes - Automate.ax

square.listDisputes returns a list of disputes associated with a particular account.

Example

automations/square-list-disputes.automation.ts

import { automation, onDashboardRun } from "automate.ax"
import { square } from "automate.ax/square"

export default automation("List Square Disputes", () => {
  onDashboardRun({ title: "List Square Disputes" })

  square.listDisputes({
    cursor: "cursor",
    states: "INQUIRY_EVIDENCE_REQUIRED",
    locationId: "location_id",
  })
})

Inputs

Every input accepts a compatible signal. It requires DISPUTES_READ.

Field	Type	Required	Default	Description
`cursor`	`string \| null`	No	—	A pagination cursor returned by a previous call to this endpoint. Provide this cursor to retrieve the next set of results for the original query. For more information, see Pagination.
`states`	`Square.DisputeState \| null`	No	—	The dispute states used to filter the result. If not specified, the endpoint returns all disputes.
`locationId`	`string \| null`	No	—	The ID of the location for which to return a list of disputes. If not specified, the endpoint returns disputes associated with all locations.

Use the official ListDisputes reference for provider field semantics and limits.

Output

Returns the official Square.ListDisputesResponse response as a codec-safe object. Square integer money amounts remain bigint values.