Payhawk icon

Payhawk

Interact with the Zitadel API

Actions99

Overview

This node operation allows users to create a Goods Received Note (GRN) for a specific Purchase Order within an account. A Goods Received Note is a document that records the receipt of goods from a supplier, confirming quantities and condition upon arrival. This operation is useful in inventory management and procurement workflows where tracking received items against purchase orders is necessary.

Typical use cases include:

  • Automatically logging received goods into an ERP or inventory system after delivery.
  • Verifying and documenting the quantities of items received compared to what was ordered.
  • Attaching notes and documents related to the receipt for audit and record-keeping purposes.

For example, after receiving a shipment, a warehouse manager can use this node to create a GRN that lists all items and quantities received, add descriptive notes about the condition or discrepancies, and upload related documents such as delivery receipts or inspection reports.

Properties

Name Meaning
Account Id Identifier of the account under which the purchase order exists.
Purchase Order Id Identifier of the purchase order for which the goods are being received.
Note Description or remarks about the goods received, e.g., condition, discrepancies, comments.
Quantities JSON array listing purchase order items with the quantities actually received.
Document JSON object containing details of any uploaded documents related to the goods received.

Output

The node outputs JSON data representing the created Goods Received Note. This typically includes confirmation details such as the GRN identifier, status, timestamps, and possibly the recorded quantities and notes. The output structure aligns with the API response for creating a GRN.

If the node supports uploading documents, it may also handle binary data representing those files, but based on the provided code and properties, the document is passed as JSON metadata rather than raw binary.

Dependencies

  • Requires an API key credential or similar authentication token configured in n8n to authorize requests to the external service managing purchase orders and goods received notes.
  • The base URL for the API must be set in the node credentials or environment variables.
  • The node depends on an OpenAPI-based client library for making HTTP requests to the external service.

Troubleshooting

  • Missing Required Fields: Errors will occur if Account Id, Purchase Order Id, Note, or Quantities are not provided. Ensure all required fields are filled.
  • Invalid JSON Format: The Quantities and Document fields expect valid JSON strings. Malformed JSON will cause parsing errors.
  • Authentication Failures: If the API key or credentials are incorrect or missing, the node will fail to authenticate. Verify credentials configuration.
  • API Endpoint Issues: Network problems or incorrect base URL settings can cause request failures. Confirm connectivity and correct API endpoint.
  • Data Validation Errors: The external API may reject requests if quantities do not match purchase order items or if other business rules are violated. Review error messages for guidance.

Links and References

Discussion