1.Introduction
This is the manual for the integration between Opencart and Rompslomp.
- This integration is a financial integration. It is not a logistics integration. It is not suitable for updating customers in Rompslomp, printing packing slips, or synchronizing products/inventory.
- This integration does not replace the work of an accountant. It saves time because you no longer have to retype documents. The accountant is still needed for advice, expertise, and control.
- We can integrate with a Rompslomp package where we can create and read debtors and products. Please take this into account if you are currently using a trial period of Rompslomp.
Tip: Other customers using this integration found the tips in the FAQ for Opencart and in the FAQ for Rompslomp.
Installing the integration starts with signing up for a trial period, via our integrations page. After registration, you will receive an email containing an installation URL and login details. With this installation URL, you start the installation of the integration.
The installation is complete when both connection dots are green, and the settings in the Configuration tab have been entered and saved.
There is a trial period of 30 days.
If you want to install another integration, you can do so in the same way. Make sure you are logged out of the integration dashboard and preferably start the new installation in an incognito browser.
At the end of the trial or subscription period, the integration will not be automatically renewed. You will receive an offer for a one-year subscription or renewal by email at the end of this period. You can confirm the renewal by using the payment link in that email. Do you want to terminate the integration in the meantime? This can be done via the dashboard, tab Profile>>Cancel integration.
Are you switching to another web shop/accounting system and do you want to re-establish a connection? In this faq we explain how to do this.
We advise you to revoke the API key and remove the extension from your webshop when uninstalling the integration.
2.How the integration works
New orders from your webshop are retrieved from the webshop at least once per hour. The status of the order is reviewed, and if the order is allowed to be processed, this will occur. If the orders are not yet allowed to be processed, they are checked every night to see if the status has changed and the order can be processed.
Read more How the integration works .... Read less How the integration works ....
At the start of processing an order, we perform a number of checks on the Opencart order:
- It is checked whether the total of the Opencart order is equal to the sum of the amounts in the order lines plus the shipping cost amount.
- If the order is an ICP order, the VAT number is checked.
- It is checked whether a corresponding VAT code exists in Rompslomp for the VAT in each line.
- It is checked whether the order has not already been processed.
Processing a Opencart order to Rompslomp takes place in three steps:
- It is checked if the customer already exists in Rompslomp. If not, the customer is created. Matching is based on the email address.
- It is checked whether the products from the Opencart order are already present in Rompslomp. Missing products are created.
- The Rompslomp invoice is created and processed.
After the order has been forwarded and a success message from Rompslomp has been received, the order is marked as handled. The Opencart order appears at the Reporting tab on the dashboard.
If Rompslomp returns an error while processing the order, the order appears in the Errors tab on the dashboard. Via the yellow button More info more information about the problem can be found. Via the red button Report problem can the order with all necessary information easily be submitted to us after you have tried to resolve the problem yourself. If the problem is solved, in some cases the orders can be processed again with the blue Process button.
Data
Information about the data that is processed can be found in the section Day-to-day: To Rompslomp later in the manual.
3.Required: OpenCart Secret key
The integration uses an OpenCart module. You can download this module here:
- cloudinvoiceopencart2.3.zip (OpenCart version 2.3)
- cloudinvoiceopencart3.zip (OpenCart version 3)
You install the extension on your webshop via FTP. You will see the Settings cloudinvoice platform module appear under Modules in your administration panel.
Click on Install to install the module and then on Edit to configure the connection. The license key is the key you received in the registration email. You create the API key to read orders and tax rates from OpenCart yourself. You can think of this API key as a kind of password. Just like with regular passwords, a complex password means you are protecting your data even more. We therefore advise you to enter an API key with a length of at least 15, consisting of numbers, letters, uppercase letters, and the punctuation marks !, *, @, #, (, ) and =. Compose your API key carefully. A good API key makes the connection much more secure. The maximum length of the API key is 64.
4.Installation
Installing the integration starts with signing up for a trial period, via our integrations page. After registering, you'll receive an email with an installation URL and login details. Use this installation URL to start the integration installation.
Activating the integration consists of three steps:
1. Establishing the connection with the OpenCart webshop. Through this step, you authorize the integration to read the data from your webshop.
2. Establishing the connection with Rompslomp. This authorizes the integration to write transactions to your Rompslomp administration and read information.
3. Configuring additional data, such as the VAT settings.
Authentication with your OpenCart webshop is done via the API key you created in a previous section. Click the red Connect button next to OpenCart and enter the API key in the popup window. If the connection is correctly established, the indicator will turn green. If the connection is not established, check that the API key has a maximum length of 64 and that the license key was not accidentally entered.
Rompslomp connection
The connection with Rompslomp runs via OAuth. Make sure you are logged out of Rompslomp before starting the connection. Now click the red Connect button. A login screen for your Rompslomp account will automatically appear. If you log in, you will get a screen asking if you allow the connection. If you confirm this, the connection with Rompslomp will be established.
After the connection with Rompslomp has been established, the administration for the connection must be set. Only then can other settings be made, such as the VAT rates. Refresh the screen with the arrows next to the Copy button to retrieve the data belonging to the administration. Invoice layout Rompslomp
After selecting the administration and refreshing the screen via the arrows next to the Copy button, an invoice layout can be selected.
When configuring the VAT rates and general ledger accounts, a link is created between the VAT rates in webshop and the VAT codes and revenue accounts in Rompslomp. You can always make changes by clicking the blue 'Edit' button and selecting an option from the drop-down menus.
By default, all EU countries are shown in the list. You only need to configure the countries you sell to, and - if applicable - ICP and International.
The integration shows the standard VAT rates for Europe. You can adjust the VAT percentage with which you sell - left column. For example: By default, sales to Germany are set to 21%, but if you sell in the webshop with 19%, you can adjust that in the left column. Intra-Community (ICP) and international deliveries
The Intra-Community supplies / ICP option is intended for business-to-business deliveries within the EU. These sales are invoiced with 0% VAT. A VAT number from the customer is required. The International option applies to deliveries outside the EU. For these sales, the integration expects 0% VAT; otherwise, the sales cannot be processed. Separate VAT codes and general ledger accounts can be configured for both ICP and international deliveries.
Once the VAT settings have been configured and saved, you will always see the selected VAT rates. If you want to start over, you can use the grey 'Remove VAT settings' button. Your current settings will then be deleted and you can begin again.
You can create a link here between the payment methods in the webshop and a fixed debtor in your Rompslomp administration. Orders with a payment method from the list will then always be posted to this debtor. In that case, no new debtors will be created.
Note: It is not possible to set fixed debtors for ICP orders. For an ICP order, a valid VAT number must be transmitted. Therefore, a debtor will always be created in Rompslomp for an ICP order.
5.Day-to-day: From OpenCart
In this section, we show how we retrieve the orders from the webshop.
Once an order has been processed, it cannot be processed again. Any order changed in the webshop after it has been processed will not be updated in Rompslomp.
6.Day-to-day: To Rompslomp
For orders in Opencart, invoices can be created in Rompslomp.
When processing customer information, it is first checked whether the customer has been processed before. If so, this Rompslomp debtor is used as the debtor for the Rompslomp transaction. If the customer is not yet known, they are added to Rompslomp. Matching is based on email address.
Please note: The integration only creates debtors. The integration does not modify debtors.
When processing orders to Rompslomp invoices, the integration first checks whether the products from the order already exist in Rompslomp. The integration then adds missing products to the accounting system. If a product already exists in Rompslomp, the product is not added again. The integration automatically adds the following products in Rompslomp: Shipping costs, Payment costs, Surcharge, Discount and Extra costs.
Rompslomp only accepts SKUs consisting of numbers/letters, without unusual characters.
When creating invoices, the integration uses the VAT percentage as stated in the order from Opencart. Even if there is a different VAT percentage in the product of Rompslomp.
The integration creates the invoice in Rompslomp, but will not automatically send the invoice to the debtor. It is possible to set an invoice layout. This can be done via the dashboard https://uwkoppeling.webwinkelfacturen.nl, tab Configuration.
Field-level specification Rompslomp
| Name | Example | Note |
| sales_invoice | ||
| date | 2023-01-02 | order date |
| due_date | 2023-01-16 | Two weeks after the order date - this cannot be adjusted. |
| contact_id | 4556686965 | customer number from Rompslomp |
| Valuta | eur | valuta |
| Description | 298 |
Order number, on request invoice number. With a negative order Credit order number, on request invoice number. |
| invoice_lines | ||
| product_id | 4970548064 | product id from Rompslomp |
| quantity | 1 | quantity |
| vat_rate | 0.21 | VAT percentage |
| vat_type_id | 701184043 | VAT code |
| account_id | 5464900859 | |
| price_per_unit | 12.40 | Unit price excl. VAT |
| description | 14 days extension | Description |
| template_id | 4460540845 | |
| validates_vat_number | ||
| Name | Example | Note |
| is individual | true | |
| address | [address][housenumber] | |
| Postal code | [zipcode] | |
| City | [city] | |
| Country | [isocountry] | |
| CoCnumber | [coc] | |
| VATnumber | [VATnr] | If vatnumber is not provided, it is empty by default. |
| contact person name | [firstname][lastname] | |
| [email] | ||
| Phone number | [telnr] | |
| Company name | [company] | If a company name is provided, then is_individual -> false. |
| Name | Example | |
| product | ||
| in stock | true | |
| lines | ||
| description | product name | |
| VATpercentage | [Taxpercentage] | |
| VATtype id | [VAT ID] | |
| price per piece | [priceExcl] | |
| Productcode | [articlekey] | |
7.Support
Read more Support .... Read less Support ....
Explanation tabs dashboard
On the Dashboard >> Report you can see which orders from your Opencart webshop, and when, have been transferred to Rompslomp.What if orders are missing in Rompslomp
If orders are missing in Rompslomp we recommend following the steps below:- Log in to the dashboard: https://uwkoppeling.webwinkelfacturen.nl. The username and password are included in the registration email.
- Go to the Errors tab and check if order is there. You may need to adjust the search period if the
order is from a previous month. If you find order in this overview:
- Check the error code and verify whether you can resolve it yourself.
- If yes resolve the issue and click the blue Process button to resubmit the order.
- If not use the red Report problem button to create a ticket with us.
- Note if there are multiple errors, please create only 1 or 2 tickets. We will automatically see the other issues.
- Go to the Report tab and see if order is listed there. If so, you'll often see an identifier for Rompslomp (in the purple section of the overview) that you can use to search for order.
- Go to the Open tab and check if order is there.
- If you cannot resolve the issue, you can always create a ticket via the green Ask us button.