Publish Invoice - Automate.ax

square.publishInvoice publishes the specified draft invoice.

Example

automations/square-publish-invoice.automation.ts

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

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

  square.publishInvoice({
    invoiceId: "invoice_id",
    version: 1,
    idempotencyKey: "32da42d0-1997-41b0-826b-f09464fc2c2e",
  })
})

Inputs

Every input accepts a compatible signal. It requires INVOICES_WRITE and ORDERS_WRITE.

Field	Type	Required	Default	Description
`invoiceId`	`string`	Yes	—	The ID of the invoice to publish.
`version`	`number`	Yes	—	The version of the invoice to publish. This must match the current version of the invoice; otherwise, the request is rejected.
`idempotencyKey`	`string \| null`	No	—	A unique string that identifies the `PublishInvoice` request. If you do not provide `idempotency_key` (or provide an empty string as the value), the endpoint treats each request as independent. For more information, see Idempotency.

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

Output

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