List Invoices - Automate.ax

square.listInvoices returns a list of invoices for a given location.

Example

automations/square-list-invoices.automation.ts

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

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

  square.listInvoices({
    locationId: "location_id",
    cursor: "cursor",
    limit: 1,
  })
})

Inputs

Every input accepts a compatible signal. It requires INVOICES_READ.

Field	Type	Required	Default	Description
`locationId`	`string`	Yes	—	The ID of the location for which to list invoices.
`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 your original query. For more information, see Pagination.
`limit`	`number \| null`	No	—	The maximum number of invoices to return (200 is the maximum `limit`). If not provided, the server uses a default limit of 100 invoices.

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

Output

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