suiteportal

n8n community node for Suite Portal API

Package Information

Downloads: 137 weekly / 731 monthly
Latest Version: 1.2.4
Author: Trey Hulse

Documentation

n8n-nodes-suiteportal

n8n community node for Suite Portal Public API integration.

Features

  • Dynamic API Version Selection: Automatically discovers and loads available API versions based on your credentials
  • Dynamic Resource Selection: Automatically discovers and loads available resources for the selected API version
  • Flexible Resource Operations: Works with any resource type supported by your API key's scopes
  • Pagination Support: Built-in pagination for large datasets
  • Search & Filtering: Advanced search and filtering capabilities
  • Sorting: Flexible sorting options

Installation

  1. Install the package in your n8n instance:
npm install n8n-nodes-suiteportal
  1. Restart your n8n instance.

Credentials

The node requires Suite Portal API credentials:

  • API Key: Your bearer token for Suite Portal Public API (Better Auth API key)
  • Base URL: The base URL of your Suite Portal API instance (default: https://suiteportal.io)

Configuration

API Version

The node automatically discovers available API versions (e.g., v1, v2) based on your API key's scopes. Select the version you want to use from the dropdown.

Resource

The node automatically discovers available resources (e.g., invoices, sales, purchases) for the selected API version based on your API key's permissions. Resources are dynamically loaded based on:

  • The selected API version
  • Your API key's scopes and permissions
  • The tenant/organization associated with your API key

Operations

Get Many

Retrieve multiple records from the selected resource with pagination, search, sorting, and filtering.

Query Parameters:

  • Page: Page number for pagination (default: 1, starts at 1)
  • Page Size: Number of items per page (default: 50)
  • Search: Search term to filter results (searches across transaction ID, entity, and memo fields)
  • Sort By: Field to sort by (default: tranDate)
  • Sort Direction: Ascending or descending (default: asc)
  • Filters: Filter parameters in format key:value (comma-separated for multiple filters, e.g., status:paid,amount:1000)

Example Filters:

  • Single filter: status:paid
  • Multiple filters: status:paid,amount:1000

Development

Build

npm run build

Watch

npm run dev

License

MIT

Discussion