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 of items delivered against a purchase order.

Common scenarios where this node is beneficial include:

  • Inventory management workflows where received goods need to be logged automatically.
  • Accounting processes requiring confirmation of goods receipt before payment.
  • Supply chain automation to track delivery status and update purchase orders accordingly.

For example, after receiving a shipment, a user can run this node to record the quantities received along with notes describing the condition or any discrepancies, optionally attaching 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, issues, or comments.
Quantities JSON list specifying purchase order items and the quantities actually received.
Document JSON object containing details of any uploaded document(s) related to the goods receipt.

Output

The node outputs a JSON object representing the created Goods Received Note. This typically includes confirmation details such as the GRN identifier, linked purchase order, received quantities, notes, and any attached documents.

If binary data is involved (e.g., uploaded documents), it would represent files associated with the GRN, but based on the provided code and properties, the main output is structured JSON data confirming the creation of the note.

Dependencies

  • Requires an API key credential or similar authentication token to interact with the external service managing purchase orders and goods received notes.
  • The node depends on a REST API endpoint configured via base URL in credentials.
  • Input JSON properties must be correctly formatted, especially for quantities and document.

Troubleshooting

  • Invalid or missing identifiers: Ensure that both Account Id and Purchase Order Id are valid and exist in the system; otherwise, the API will reject the request.
  • Malformed JSON inputs: The quantities and document fields expect valid JSON strings. Parsing errors will cause failures.
  • Authentication errors: Verify that the API key or authentication token is correctly set up and has sufficient permissions.
  • API connectivity issues: Check network access and base URL configuration if requests fail to reach the service.
  • Empty or incomplete required fields: All required fields (accountId, purchaseOrderId, note, quantities) must be provided; missing these will result in validation errors.

Links and References

Discussion