Square icon

Square

Consume Square API

Actions37

Invoice → Search

AI-generated

Overview

This node performs a search operation on invoices using the Square API. It allows users to filter invoices based on location IDs and customer IDs, and supports returning either all matching results or a limited number of results. This is useful for scenarios where users need to find specific invoices or analyze invoice data filtered by certain criteria, such as invoices from particular locations or customers.

Use Case Examples

  1. Search all invoices for a specific customer by providing the customer ID filter.
  2. Retrieve a limited number of invoices from specific locations to analyze recent transactions.

Properties

Name Meaning
Return All Whether to return all matching invoice results or only up to a specified limit.
Limit The maximum number of invoice results to return when 'Return All' is false.
Search Fields Filters to apply to the invoice search, including location IDs and customer IDs to narrow down the results.

Output

JSON

  • id - Unique identifier of the invoice.
  • location_id - Identifier of the location associated with the invoice.
  • customer_id - Identifier of the customer associated with the invoice.
  • status - Current status of the invoice.
  • version - Version number of the invoice for concurrency control.
  • due_date - Due date of the invoice.
  • amount_money - Monetary amount details of the invoice.

Dependencies

  • Square API access with an API key credential

Troubleshooting

  • Ensure that the API credentials are correctly configured and have the necessary permissions to access invoice data.
  • If the node returns an error about invalid JSON, verify that the input fields, especially filters, are correctly formatted and do not contain syntax errors.
  • When using the 'Return All' option, be aware of potential large data volumes which might impact performance or API rate limits.

Links

  • Square API - Search Invoices - Official Square API documentation for searching invoices, detailing available filters and response structure.

Discussion