Import From vPlan

The Import From vPlan node provides integration with the vPlan API directly inside a dataflow, allowing retrieval of entities such as orders, collections, projects, and activities. It communicates with all available vPlan API endpoints, including orders, activities, boards, resources, and custom entities, and is actively maintained to stay compatible with the latest API versions and features released by vPlan.

Configuration

Setting	Type	Required	Description
Connection	Select	Yes	The vPlan connector containing the API key or OAuth token.
Advanced	Button	Yes	Opens the configuration window to select entities, fields, filters, and output behavior.
Entity library	Select	Yes	Defines which version of the entity model to use (e.g. Legacy or Latest).
Page Size	Numeric	No	Number of records to fetch per request (default: 1000).
Include Archived	Boolean	No	When enabled, archived entities are also retrieved.

Entity configuration

Setting	Type	Required	Description
Entity	Select	Yes	Which vPlan entity to import (e.g. Order, Activity, Collection, Project, Resource).
Columns	Select	Yes	The selected columns to import for the chosen entity.
Filter	Filter icon	No	Opens the filter dialog for column-based filtering. Filters appear in the Filters tab.

Filtering

Each filter consists of:

Field	Description
Target	Field or column to filter on.
Condition	Comparison operator (e.g. Equals, Not Equals, Contains, Starts With, Ends With).
Value	The value used in the comparison. Supports static values and expressions.

Example:

Target: board_id
Condition: Equals
Value: aa6fb2a3-bfd5-4aef-b423-5c73f5e2b0cd

Multiple filters can be combined.

Execution flow

Typical usage: a Daily Trigger activates the flow, the Import From vPlan node retrieves selected vPlan entities, a Query node filters or transforms data, and the processed data is sent to downstream systems (e.g. ERP, Exact).

Input / output

Direction	Type	Description
Input	Table	Used only when executing dynamically (e.g. for-each-row filtering).
Output	Table	Returns retrieved vPlan entities and column values.

Errors & troubleshooting

Error message	Meaning	Solution
401 Unauthorized	Invalid API credentials.	Check the vPlan connector configuration.
404 Not Found	Selected entity does not exist.	Verify entity name and library version.
400 Bad Request	Invalid request parameters or filters.	Validate fields and filter values.
Rate Limit Exceeded	Too many API calls.	Reduce Page Size or throttle requests.

Tips

• Use filters to limit dataset size and improve performance.
• Enable Include Archived only when historical data is required.
• Combine with a Query or Transform node for enrichment or restructuring.
• Keep Page Size high (e.g. 1000) to minimize API requests for large imports.