Ploomes CRMInstall

Summary

Retrieves currency records from the Ploomes CRM /Currencies endpoint using OData query options (top, skip, select, orderby, filter, expand), with optional in-memory caching. Each returned record becomes its own output item.

Inputs

• Cache Strategy — Disabled (default) always calls the API. Cache First returns a cached response for the same URL and query if one exists and is within the TTL. Fallback Only always calls the API and uses the cache only if the request fails. The cache is in memory and lasts until n8n restarts.
• Cache TTL (Seconds) — How long a cached response stays valid. Default 300, minimum 1. Shown only when the cache strategy is not Disabled.
• $top (Limit) — Maximum number of records to return. Default is 1, so raise it to get more than one currency. Minimum 1.
• $skip (Offset) — Number of records to skip, for pagination. Default 0. The node does not paginate automatically.
• $select (Fields) — Comma-separated fields to return. Default is Id, so set it (e.g. Id,Name) to get more than the ID.
• $orderby (Sort) — Sort field with optional asc/desc. Default is Id.
• Use Filter Builder — Default true. When on, the visual filter builders below are used. When off, the raw $filter string is used.
• $filter (Raw) — Raw OData $filter expression, sent as written. Shown only when Use Filter Builder is off.
• Filter Conditions — One or more conditions, each with Field, Operator (eq, ne, gt, ge, lt, le, contains, startswith, endswith), Value, Value Type (auto, string, number, boolean, date, null) and a Logical Operator (AND/OR) to link to the next condition. Auto leaves numeric-looking values unquoted and quotes everything else. Shown only when the filter builder is on.
• Custom Property Filters — Filters on custom field values, written as OtherProperties/any(...). Each takes a Field ID, a value property, an operator, a value, and a numeric flag. They are joined to each other and to the main filter with AND. Shown only when the filter builder is on.
• Navigation Property Filters — Filters on related entities, either Collection/any(...) lambdas or direct paths like City/Id eq 3941. Each takes a property, field, operator, value and logical operator. They are ANDed to the rest of the filter. Shown only when the filter builder is on.
• Use Expand Builder — Default true. When on, Expand Relations and Expand Nested Filters build the $expand. When off, the raw string is used.
• $expand (Raw) — Raw OData $expand expression. Shown only when Use Expand Builder is off.
• Expand Relations — Navigation properties to expand. Each can have a nested $select, a nested $filter and a nested $expand.
• Expand Nested Filters — Builder conditions applied inside a named expansion. The expansion property must match a property in Expand Relations. They are combined with any manual nested filter using AND.

Output shape

One output item per currency record, taken from the API's value array. If the response has no value array, the whole response becomes a single item. Items go to the first output (Success).

Failed requests go to the Error output, or to the Timeout output for HTTP 408/504. Each carries an error, statusCode, isTimeout, resource, operation and timestamp payload. Timeouts never stop the workflow. Other errors stop it unless Continue On Fail is enabled. Items served from cache include _fromCache: true. Items served from cache after a failed request also include _fallback: true. With the defaults ($top 1, $select Id) only a single record with its Id is returned. An empty response body yields a {success, resource, operation, timestamp} item. The node runs once per input item.

Examples

Example 1: List all currencies with their names and codes

Set $top to 100, $select to Id,Name, and leave the filters and expand empty. Check the Ploomes API for the exact field names.

Example 2: Find a currency by code using a filter condition

Use Filter Builder on. Add a condition with Field Code, Operator eq, Value USD, Value Type String. Set $select to Id,Name,Code.

Example 3: Cache a rarely changing currency list to cut API calls

Set Cache Strategy to Cache First, Cache TTL to 3600, $top to 100, and $select to Id,Name.

Links

• n8n community nodes installation guide