Actions12
Overview
This node integrates with the Square API to manage invoices. Specifically, the "Get" operation for the "Invoice" resource retrieves detailed information about a single invoice by its unique ID. This is useful in scenarios where you need to fetch the current status, amount, customer details, or other metadata of an invoice stored in Square.
Practical examples include:
- Retrieving invoice details to display in a dashboard.
- Fetching invoice data before performing updates or sending reminders.
- Integrating invoice information into accounting or CRM workflows.
Properties
| Name | Meaning |
|---|---|
| Invoice ID | The unique identifier of the invoice to retrieve. This is required to specify which invoice's details should be fetched from Square. |
Output
The node outputs JSON data representing the full details of the requested invoice as returned by the Square API. This typically includes fields such as invoice ID, location, customer info, line items, payment status, due date, and version number.
No binary data output is produced by this operation.
Dependencies
- Requires an active connection to the Square API via an API key credential configured in n8n.
- The node dynamically selects the base URL depending on whether the environment is set to sandbox or production.
- Network access to Square's API endpoints is necessary.
Troubleshooting
Common issues:
- Providing an invalid or non-existent Invoice ID will result in an error response from the API.
- Missing or incorrect API credentials will cause authentication failures.
- Network connectivity problems can prevent successful API calls.
Error messages:
- Errors returned by the Square API (e.g., "Invoice not found") are surfaced by the node.
- If the node is set to continue on failure, errors for individual items are included in the output JSON with an
errorfield. - To resolve errors, verify the Invoice ID correctness, ensure valid API credentials, and check network connectivity.