ClientConnector (CLI)

The ClientConnector is eConnect's Windows CLI tool for exchanging invoices via local folders. When to use it and how to set it up.

The ClientConnector is the only CLI tool eConnect offers for invoice exchange. It is not a REST API client: the tool runs on Windows, monitors local folders and exchanges files with the eConnect platform.

PlatformWindows (not available for Linux or macOS)Integration typeFile exchange via local foldersSubscriptionProfessional + subscription key via sales

Note: this is different from the PHP or .NET SDKs. The SDKs talk directly to the PSB REST API. The ClientConnector is intended for software that can only read and write files in a folder.

When to use it

Use the ClientConnector when:

  • your source system does not support HTTP/API integration (legacy on-premise software)
  • the Email Receiver or a direct API integration is not an option
  • scripts or automation need to submit or retrieve invoices via files

For new integrations in PHP, .NET or other languages with API support, an SDK or OpenAPI client is usually the better choice.

How it works

The ClientConnector runs as a background process on your Windows server:

  • Send folder — files your software places here are sent to eConnect
  • Receive folder — incoming invoices from eConnect are placed here

The tool polls periodically for new files. Your software only needs to write and read files; authentication and transport are handled by the ClientConnector.

[Your software] → send folder → [ClientConnector] → eConnect PSB
[Your software] ← receive folder ← [ClientConnector] ← eConnect PSB
Installation and configuration
Step 1: Create a connection
  1. Sign in to platform.econnect.eu.
  2. Go to Connections in your organisation.
  3. Click the orange circle (+) → New general connection.
  4. Select Local folder / CLI tool.
  5. Generate connection keys and copy them.

See Connection keys for more context on key management.

Step 2: Install ClientConnector
  1. Download the ClientConnector via the eConnect platform or request it from support.
  2. Install it on the Windows server where your source system runs.
  3. Configure connection keys and paths for the send and receive folders.
Step 3: Connect your source system

Configure your software to export invoices to the send folder and import from the receive folder. The exact steps depend on your package.

Supported software

The ClientConnector is used with Syntess among others (send and receive). Other packages that can read/write files to a local folder are suitable in principle.

Automation

Scripts and workflows can communicate with eConnect via the folder structure without making HTTP calls themselves. This is useful for automated processing on Windows servers, but it does not replace a PSB API integration on other platforms.

For API automation in CI/CD (validation, test sends) use the REST API with curl, an SDK or a generated client — see OpenAPI codegen.

Requirements
  • Windows server
  • Professional subscription with eConnect
  • Subscription key (via sales)
  • Connection keys from the platform
  • Disk space for send and receive folders
Full documentation

Step-by-step instructions, FAQ and troubleshooting are in the full article:

ClientConnector: connect via a local folder