import type * as Square from "../../../../index"; /** * @example * { * invoiceId: "invoice_id", * invoice: { * version: 1, * paymentRequests: [{ * uid: "2da7964f-f3d2-4f43-81e8-5aa220bf3355", * tippingEnabled: false * }] * }, * idempotencyKey: "4ee82288-0910-499e-ab4c-5d0071dad1be" * } */ export interface UpdateInvoiceRequest { /** The ID of the invoice to update. */ invoiceId: string; /** * The invoice fields to add, change, or clear. Fields can be cleared using * null values or the `remove` field (for individual payment requests or reminders). * The current invoice `version` is also required. For more information, including requirements, * limitations, and more examples, see [Update an Invoice](https://developer.squareup.com/docs/invoices-api/update-invoices). */ invoice: Square.Invoice; /** * A unique string that identifies the `UpdateInvoice` 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](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency). */ idempotencyKey?: string | null; /** * The list of fields to clear. Although this field is currently supported, we * recommend using null values or the `remove` field when possible. For examples, see * [Update an Invoice](https://developer.squareup.com/docs/invoices-api/update-invoices). */ fieldsToClear?: string[] | null; }