List Payout Entries - Automate.ax

square.listPayoutEntries retrieves a list of all payout entries for a specific payout.

Example

automations/square-list-payout-entries.automation.ts

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

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

  square.listPayoutEntries({
    payoutId: "payout_id",
    sortOrder: "DESC",
    cursor: "cursor",
    limit: 1,
  })
})

Inputs

Every input accepts a compatible signal. It requires PAYOUTS_READ.

Field	Type	Required	Default	Description
`payoutId`	`string`	Yes	—	The ID of the payout to retrieve the information for.
`sortOrder`	`Square.SortOrder \| null`	No	—	The order in which payout entries are listed.
`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. If request parameters change between requests, subsequent results may contain duplicates or missing records.
`limit`	`number \| null`	No	used instead	The maximum number of results to be returned in a single page. It is possible to receive fewer results than the specified limit on a given page. The default value of 100 is also the maximum allowed value. If the provided value is greater than 100, it is ignored and the default value is used instead. Default: `100`

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

Output

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