Square icon

Square

Consume Square API

Invoice → Update

AI-generated

Overview

This node updates an existing invoice in the Square system. It requires the invoice ID and the version of the invoice to be updated, along with any fields that need to be changed. This operation is useful for modifying invoice details such as description, invoice number, payment requests, and title after the invoice has been created.

Use Case Examples

  1. Updating the description and title of an invoice to reflect new information.
  2. Changing the invoice number or adding payment requests with specific due dates and tipping options.

Properties

Name Meaning
Invoice ID The unique identifier of the invoice to update.
Version The version number of the invoice to update, ensuring concurrency control.
Update Fields A collection of fields to update on the invoice, including description, invoice number, payment requests, and title.

Output

JSON

  • invoice
    • id - The unique identifier of the updated invoice.
    • version - The version number of the updated invoice.
    • description - The updated description of the invoice.
    • invoice_number - The updated invoice number.
    • payment_requests - The updated list of payment requests for the invoice.
    • title - The updated title of the invoice.

Dependencies

  • Square API with an API key credential

Troubleshooting

  • If no fields are provided to update, the node throws an error prompting to enter at least one field to update.
  • Errors from the Square API such as invalid invoice ID or version mismatch will be thrown and should be handled appropriately.
  • Ensure the API credentials are correctly set and have permissions to update invoices.

Discussion