Connecting Cin7 Omni to dashboard.salesmatrix.com
In this guide, the dashboard.salesmatrix.com system is called Salesmatrix. Salesmatrix reads your sales data directly from Cin7 Omni, the original Cin7, over its API. There is nothing to install. You create an API connection in Cin7 Omni, enter it when you register, and Salesmatrix imports your data every night.
- Before you start
- Create an API connection
- Register your company
- What Salesmatrix imports
- Manage the connection
- Troubleshooting
Before you start
- Check which Cin7 you use. This guide is for Cin7 Omni. If your Cin7 was formerly called DEAR Inventory, it is Cin7 Core: follow the Cin7 Core guide instead.
- A Cin7 Omni login that can open Integrations & API, usually an administrator, so you can create an API connection.
- An email address you can check now. It becomes the first administrator login for your Salesmatrix dashboard.
Create an API connection in Cin7 Omni
Open the API page
Sign in to Cin7 Omni and choose Settings, then Integrations & API, then API v1.
Add a connection for Salesmatrix
Add a new API connection and name it Salesmatrix, so you can recognise it later. Give it read access to Contacts, Products, Sales Orders and Users. Salesmatrix never writes to Cin7 Omni, so it needs no other permissions.
Copy the two values
Cin7 Omni shows an API Username and an API Key. Keep this page open, or copy both somewhere safe: you enter them in the next section.
Anyone with the API Username and Key can read your Cin7 Omni data. Only enter them on dashboard.salesmatrix.com. If you ever need to cut Salesmatrix off, delete the Salesmatrix API connection in Cin7 Omni.
Register your company
Open the registration page
Go to dashboard.salesmatrix.com/Register/SWOTRegistration and fill in Company Name, Administration Email Address, Contact person name and, optionally, Contact No. Check that Country is right.
Choose Cin7 Omni and enter your key
Choose Cin7 Omni under Accounting Systems. Two fields appear under Enter Id and Keys:
Field Enter API Username The API Username from Cin7 Omni API Key The API Key from Cin7 Omni Test the connection
Click Test Connection. When Salesmatrix can reach Cin7 Omni you see Successfully validated connection keys, and the Register button becomes available.
Register and confirm your email
Click Register. Copy the token from the email we send you into Enter token received on email on the Confirm Registration page and click Confirm Token. You can then sign in at dashboard.salesmatrix.com.
What Salesmatrix imports
Salesmatrix imports once a night, in a time slot between 12:00 and 17:00 UTC (late evening to early morning in Australia and New Zealand). Your first data appears the morning after you register. The first import reads your last three financial years of sales, so it can take a few hours.
| Data | From Cin7 Omni |
|---|---|
| Customers | Every customer contact, with group, sub-group, sales rep, postcode and city as categories, and its main contact's name, email and phone |
| Products | Every product, with category, brand, supplier, product type and cost |
| Sales | Invoiced sales orders, line by line, with quantity shipped, value and cost |
| Credit notes | Approved credit notes, line by line, as negative sales on the credit note date |
| Sales reps | Your Cin7 Omni users, matched to the sales person on each customer and order |
Sales are dated by invoice date and credit notes by credit note date. Orders that have not been invoiced, and draft credit notes, are not imported. After the first import, each night reads the invoices and credit notes dated since the last one. If you edit an invoice or credit note from an earlier period, refresh that period from the Utilities page of your dashboard and it is read again.
Manage the connection
Sign in and open Connection from the menu. Only administrators see this page. It shows your company, your system and the API Username and API Key fields.
| Button | What it does |
|---|---|
| Test | Checks that Salesmatrix can reach Cin7 Omni with the details on the page |
| Connect | Saves the details and starts importing |
| Disconnect | Stops importing. You choose whether to keep the data already in Salesmatrix or remove it |
| ReConnect | Starts importing again after a disconnect |
Replacing the key
If you delete or regenerate the API connection in Cin7 Omni, enter the new values on the Connection page, click Test, then Connect. Salesmatrix carries on from where it stopped, so nothing is imported twice and nothing is missed.
Troubleshooting
Test Connection fails
Copy the API Username and Key again from Cin7 Omni. The key is a long code and easy to cut short, and a space before or after either value stops it working. Check that the Salesmatrix connection still exists under Integrations & API, and that it has read access to Contacts, Products, Sales Orders and Users.
I chose the wrong Cin7
Cin7 Core and Cin7 Omni use different keys, so a Core key never validates as Omni or the other way round. If you chose the wrong one, contact Salesmatrix and we will switch it.
No data the morning after registering
Open Logs in the dashboard. A large first import can still be running in the morning; check again later in the day. If Logs shows an error, or nothing at all by the next afternoon, contact Salesmatrix.
Figures differ from Cin7 Omni's own reports
Salesmatrix reports invoiced sales by invoice date, with credit notes deducted on the date they were raised. Compare with a Cin7 Omni sales report built the same way. If they still differ, send Salesmatrix the period and an invoice or two that disagree.
Salesmatrix · Cin7 Omni connection guide