Actions99
- Group Accounts Actions
- Group Account Codes Actions
- Accounts Actions
- Expenses Actions
- Purchase Orders Actions
- Get A List Of Purchase Orders
- Create A New Purchase Order
- Get A Purchase Order
- Update A Purchase Order
- Open A Purchase Order
- Get A List Of Purchase Orders Items For A Specific Purchase Order
- Create A Purchase Order Item
- Get A Purchase Order Item
- Update A Purchase Order Item
- Delete A Purchase Order Item
- Get A List Of Goods Received Notes For A Specific Purchase Order
- Create A Goods Received Note
- Attach A File To A Goods Received Note
- Delete A Goods Received Note
- Suppliers Actions
- Fund Accounts Actions
- Cards Actions
- Expense Categories Actions
- Tax Rates Actions
- Amortizations Actions
- Account Teams Actions
- Account Codes Actions
- External Teams Actions
- Custom Fields Actions
- Get Custom Fields
- Create A New Custom Field
- Get Custom Field
- Update Custom Field
- Delete A Custom Field And All Its Values
- Get Custom Field Values
- Create A Custom Field Value
- Delete Custom Field Values
- Get A Custom Field Value
- Update A Custom Field Value
- Delete A Custom Field Value
- Get Managers For A Specific Custom Field Value
- Adds Managers For A Specific Custom Field Value
- Replaces Managers For A Specific Custom Field Value
- Removes Managers For A Specific Custom Field Value
- Webhook Subscriptions Actions
- Group Teams Actions
Overview
This node operation, "Get Custom Fields" under the "Custom Fields" resource, is designed to retrieve custom field data associated with a specific account. It is useful in scenarios where users need to fetch metadata or additional configurable fields tied to an account entity within an external system. For example, it can be used to dynamically obtain custom attributes for user profiles, customer records, or other account-related data that are not part of the standard schema.
Properties
| Name | Meaning |
|---|---|
| Account Id | Identifier of the account whose custom fields you want to retrieve |
Output
The output of this node operation will be JSON data containing the custom fields related to the specified account. The structure typically includes key-value pairs representing each custom field's name and its corresponding value or configuration. This allows downstream nodes or workflows to utilize these custom attributes for further processing, filtering, or decision-making.
If the node supports binary data output (not evident from the provided code), it would generally represent attachments or files related to the custom fields, but no such indication is present here.
Dependencies
- Requires an API key credential or similar authentication token configured in n8n to access the external service.
- The node depends on an external API described by an OpenAPI specification (
payhawk.api.json), which defines the endpoints and operations. - The base URL for API requests is expected to be set via credentials.
- Uses the
@devlikeapro/n8n-openapi-nodepackage for handling OpenAPI-based operations. - Uses
lodashfor utility functions.
Troubleshooting
- Missing or invalid Account Id: Since the Account Id is required, ensure it is provided and correctly formatted. Errors may occur if this property is empty or incorrect.
- Authentication errors: If the API key or credentials are missing or invalid, the node will fail to authenticate with the external service.
- API endpoint issues: Network problems or changes in the external API could cause failures. Verify connectivity and API availability.
- Unexpected response format: If the external API changes the structure of custom fields, downstream nodes expecting a certain JSON format might break.
Links and References
- Refer to the external API documentation for details on the custom fields endpoint.
- n8n documentation on using API key credentials and configuring HTTP request nodes.
- Lodash library documentation: https://lodash.com/
- OpenAPI Specification: https://swagger.io/specification/