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 scoping. 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 by status, purchase order number, modification date, and logical AND conditions.
Skip Number of objects to skip from the beginning of the result set. Useful for pagination to offset results.
Take Maximum number of objects to return. Defaults to 20, with a maximum limit of 1000 items. Controls page size for pagination.
Account Id Identifier of the account whose purchase orders are being queried. This is a required string property to scope the request.

Output

The output contains a JSON array of purchase order objects matching the specified filters and pagination parameters. Each item 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, dates, and related metadata.

No binary data output is indicated for this operation.

Dependencies

  • Requires connection to an external API service that manages purchase orders.
  • Needs an API authentication token or key configured in the node credentials to authorize requests.
  • The base URL for the API must be set in the node's credential configuration.

Troubleshooting

  • Empty results: Ensure the Account Id is correct and that the filter criteria are not overly restrictive.
  • Invalid filter format: The Filter property must be a valid JSON string conforming to the expected schema; malformed JSON will cause errors.
  • Pagination issues: Setting Take to zero may default to 20, but exceeding 1000 will likely be rejected by the API.
  • Authentication errors: Verify that the API key or token is correctly configured and has sufficient permissions.
  • Network errors: Check connectivity and base URL correctness.

Links and References

  • Refer to the external API documentation for the purchase order resource and filter schema (IPurchaseOrderFilter) for detailed information on supported filter fields and values.
  • n8n documentation on pagination and query parameter usage for best practices when using Skip and Take.

Discussion