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
- Cards Actions
- Suppliers Actions
- Fund Accounts 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 allows users to create a new custom field within an account in an external system. Custom fields are user-defined data points that can be added to records to capture additional information not covered by default fields. This operation is useful for tailoring data structures to specific business needs, such as adding specialized attributes to customer profiles, products, or transactions.
Practical examples include:
- Adding a "Customer Loyalty Tier" field to track membership levels.
- Creating a "Warranty Expiration Date" field for product records.
- Defining a "Preferred Contact Method" field for client communication preferences.
Properties
| Name | Meaning |
|---|---|
| Account Id | Identifier of the account where the custom field will be created. |
| Label | The display label/name of the custom field. |
| Is Required | Boolean indicating if this custom field must always have a value (true = required). |
| Description | A textual description explaining the purpose or usage of the custom field. |
| External Id | Unique identifier for the custom field in the external system, used for integration purposes. |
| External Source | Identifier of the external system from which this custom field originates. |
| Type | The type of the custom field. Options: - Dynamic List - Predefined List - Free Text Input - Date |
Output
The node outputs JSON data representing the newly created custom field object as returned by the external API. This typically includes all properties sent during creation along with any additional metadata assigned by the system, such as unique IDs or timestamps.
If the node supports binary data output, it would represent associated files or attachments related to the custom field, but based on the provided code and properties, this operation focuses solely on JSON data.
Dependencies
- Requires an API key credential or similar authentication token configured in n8n to authorize requests to the external system's API.
- The base URL for the API must be set in the node credentials or environment variables.
- The node depends on an OpenAPI specification (
payhawk.api.json) for request construction and response parsing. - Uses the
@devlikeapro/n8n-openapi-nodepackage for handling OpenAPI-based operations.
Troubleshooting
- Missing Required Fields: If "Account Id" or "Label" is not provided, the API will likely reject the request. Ensure these mandatory fields are filled.
- Invalid Field Type: Selecting a type outside the allowed options may cause errors. Use only the specified types.
- Authentication Errors: If the API key or credentials are missing or invalid, the node will fail to authenticate. Verify credentials configuration.
- API Endpoint Issues: Incorrect base URL or network issues can prevent successful API calls. Confirm connectivity and endpoint correctness.
- Duplicate External Ids: Using an existing external ID might cause conflicts. Use unique identifiers when integrating with external systems.
Links and References
- OpenAPI Specification – Understanding the API definition format used.
- n8n Documentation – General guidance on creating and using custom nodes.
- REST API Best Practices – For designing and troubleshooting RESTful API interactions.