Square icon

Square

Consume Square API

Overview

This node integrates with the Square API to manage invoices among other resources. Specifically, the Invoice - Get operation retrieves detailed information about a single invoice by its unique ID. This is useful in scenarios where you need to fetch invoice data for review, processing, or integration with other systems.

Practical examples include:

  • Fetching an invoice to display its details in a custom dashboard.
  • Retrieving invoice data before updating 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 to get.

Output

The node outputs the JSON representation of the requested invoice as returned by the Square API. This typically includes fields such as invoice ID, location, customer details, invoice status, line items, amounts, and timestamps.

No binary data output is produced by this operation.

Dependencies

  • Requires an API key credential for authenticating with the Square API.
  • The node uses the Square API base URL, switching between sandbox and production environments based on the configured credentials.
  • No additional external dependencies are needed beyond the Square API access.

Troubleshooting

  • Common issues:

    • Providing an invalid or non-existent Invoice ID will result in an error from the Square API.
    • Network connectivity problems can cause request failures.
    • Insufficient permissions or incorrect API credentials may lead to authorization errors.
  • Error messages:

    • Errors returned by the Square API (e.g., "Invoice not found") will be surfaced by the node.
    • If the node is set to continue on failure, errors will be included in the output JSON with an error field.
    • To resolve errors, verify the Invoice ID, check API credentials, and ensure network connectivity.

Links and References

Discussion