Setting up the Collmex integration and testing the connection
The Collmex Integration connects your Collmex account to easycompliance. Once it is set up, easycompliance automatically synchronises your active customers and suppliers from Collmex into your monitoring every night – so you no longer have to maintain these business partners by hand.
Requirements
- A Collmex account in which you are allowed to create a user.
- Your Collmex Customer Number.
- An API user with a display/read-only role (in Collmex the Anzeiger role).
- Your company number (usually
1).
Step by step
1. Create an API user in Collmex
If you do not yet have an API user in Collmex, create one first. easycompliance points you to the following path in Collmex:
- In Collmex, click Verwaltung (Administration) → Benutzer (Users) → Benutzer anlegen (Create user).
- Assign this user the Anzeiger role (a pure display/read-only role – no further rights are needed).
- Note down the user name and password of this API user.
Also determine your company number: it is usually 1. To be sure, check it in Collmex under Verwaltung → Firma anzeigen und ändern (View and change company).
2. Fill in the integration in the customer portal
In the customer portal, open the “Collmex Integration” page and complete the form:
- “Collmex Customer Number” – your customer number at Collmex.
- “API User” – the user name of the API user you created in step 1.
- “Password” – the password of that API user. Use the eye icon (“Show Password”) to make the entry visible and check it.
- “Company No.” – your company number (usually
1). - “Integration active” – choose “Yes” so that the nightly synchronisation actually runs. With “No” you save the data without starting the synchronisation.
All fields marked with * are required.
3. Save first, then test
- Click “Save”. On success the following message appears: “Daten erfolgreich gespeichert. Bitte testen Sie die Verbindung.” (Data saved successfully. Please test the connection.)
- Only then does the “Verbindung testen” (Test connection) area appear, with the note “Nach dem Speichern können Sie die Verbindung zu Collmex testen.” (After saving, you can test the connection to Collmex.)
- Click “Verbindung testen” (Test connection).
Important: The test uses the saved data, not what you have just typed into the form. Therefore always save first before you test any change.
If the test succeeds, this appears: “Verbindung zu Collmex erfolgreich. Ihre Datensätze werden, sofern Sie die Schnittstelle aktivieren, jede Nacht automatisch importiert.” (Connection to Collmex successful. Provided you activate the integration, your records will be imported automatically every night.)
If the test fails, this appears: “Verbindung zu Collmex fehlgeschlagen. Bitte prüfen Sie Ihre Eingaben.” (Connection to Collmex failed. Please check your entries.)
The “Collmex Integration” page: on the left the configuration form with “Save” and “Test connection”, on the right the setup guide.
Good to know
- What happens after setup: Once the connection is in place and “Integration active” is set to “Yes”, easycompliance automatically imports your active customers and suppliers from Collmex into your monitoring every night. You do not need to do anything else.
- Read-only rights are enough: The API user only needs the Anzeiger role. easycompliance only reads your data and never changes anything in Collmex.
- Company number: In the vast majority of accounts the company number is 1. If in doubt, check it in Collmex under Verwaltung → Firma anzeigen und ändern.
- Order matters: The “Test connection” area only appears after you have saved for the first time, and it always tests the most recently saved credentials.
- Save without activating right away: You can also save the credentials with “Integration active” = “No” (for example to prepare everything) – the nightly synchronisation then starts only once you switch it to “Yes”.
Frequently asked questions
In which order do I proceed – test first or save first? Always save first, then test. The connection test uses the saved data, not your unsaved form input. That is also why the “Test connection” button only appears after you have clicked “Save” once.
The message “Verbindung zu Collmex fehlgeschlagen. Bitte prüfen Sie Ihre Eingaben.” appears – what now? Check the Collmex Customer Number, API User, Password and Company No. for typos. Make sure the API user exists in Collmex and has the Anzeiger role. Correct the fields, click “Save” again and then “Test connection”.
Which company number do I enter in “Company No.”? Usually 1. If you are unsure, check the number in Collmex under Verwaltung → Firma anzeigen und ändern.
Which role does the API user need in Collmex? The Anzeiger role (a pure display/read-only role). No further rights are required, because easycompliance only reads your data.
Does “Integration active” have to be set to “Yes”? For the automatic nightly synchronisation, yes. With “No” your credentials are saved, but no automatic import takes place.
How often is my Collmex data imported? Automatically every night. Your active customers and suppliers from Collmex are imported.
Related articles
Last reviewed: