Payhawk icon

Payhawk

Interact with the Zitadel API

Actions99

Overview

This node operation retrieves a list of purchase orders from an external service. It is useful for scenarios where you need to fetch multiple purchase orders with optional filtering, pagination (skip and take), and account-specific querying. For example, you might use this node to display recent purchase orders in a dashboard, synchronize purchase order data with another system, or generate reports based on filtered purchase orders.

Properties

Name Meaning
Filter A JSON-stringified and URL-encoded filter expression object that conforms to the IPurchaseOrderFilter schema. Allows fine-grained filtering of purchase orders by status, purchase order number, modification date, and logical combinations of these criteria.
Skip Number of objects to skip from the beginning of the result set. Useful for pagination to ignore a certain number of initial results.
Take Maximum number of purchase order objects to return. Defaults to 20, with a maximum limit of 1000. Controls page size for pagination.
Account Id Identifier of the account whose purchase orders are being queried. This is a required string property to specify the account context.

Output

The output contains a JSON array of purchase order objects matching the query parameters. Each object represents a purchase order with its associated details as returned by the external API. The exact structure depends on the API response but typically includes fields like purchase order number, status, modification date, and other relevant metadata.

No binary data output is indicated for this operation.

Dependencies

  • Requires an API key credential or similar authentication token configured in n8n to access the external purchase order service.
  • The base URL for the API must be set in the node credentials or environment variables.
  • The node uses HTTP requests with query parameters constructed from the input properties ($filter, $skip, $take, accountId).

Troubleshooting

  • Common issues:

    • Invalid or missing accountId will cause the API request to fail or return no data.
    • Malformed JSON in the Filter property can lead to errors in query parsing or API rejection.
    • Exceeding the maximum allowed Take value (over 1000) may result in truncated results or API errors.
    • Network or authentication failures if API credentials are not properly configured.
  • Error messages:

    • "Unauthorized" or "Authentication failed": Check that the API key or authentication token is correctly set up.
    • "Invalid filter format": Ensure the filter JSON is correctly stringified and URL-encoded.
    • "Request entity too large" or similar: Reduce the Take value or simplify the filter criteria.

Links and References

  • Refer to the external purchase order API documentation for detailed schema of filters and response objects.
  • n8n documentation on how to configure API credentials and use query parameters in nodes.

Discussion