Get Invoice - Automate.ax

square.getInvoice retrieves an invoice by invoice ID.

Example

automations/square-get-invoice.automation.ts

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

export default automation("Get Square Invoice", () => {
  onDashboardRun({ title: "Get Square Invoice" })

  square.getInvoice({
    invoiceId: "invoice_id",
  })
})

Inputs

Every input accepts a compatible signal. It requires INVOICES_READ.

Field	Type	Required	Default	Description
`invoiceId`	`string`	Yes	—	The ID of the invoice to retrieve.

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

Output

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