1.Introduction
This is the manual for the integration between Opencart and Yuki.
This integration ensures that orders from the Opencart webshop are automatically processed to invoices in Yuki. Because the orders arrive directly in the retailer's accounting system, this saves time on the financial administration.
Please pay special attention to the following
- This integration is a financial integration. It is not a logistics integration. It is not suitable for updating customers in Yuki, 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.
Tip: Other customers using this integration found the tips in the FAQ for Opencart and in the FAQ for Yuki.
Install integration
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.
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.
Cancel integration
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.
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
A order from the Opencart webshop is processed to Yuki as a Yuki invoice. The draft invoice option is default and is used most frequently. The processed invoice option can be requested from us. For both options, you need the paid sales module in Yuki.
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 ....
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 ....
Pre-check orders
At the start of processing an order, we perform a number of checks on the Opencart order:
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 Yuki for the VAT in each line.
- It is checked whether the order has not already been processed.
Processing orders
If the check is successful, the order will be processed to Yuki. The debtor details are placed in the Yuki invoice. Yuki itself processes the debtor details.
If the check is successful, the order will be processed to Yuki. The debtor details are placed in the Yuki invoice. Yuki itself processes the debtor details.
Post-check
After the order has been forwarded and a success message from Yuki has been received, the order is marked as handled. The Opencart order appears at the Reporting tab on the dashboard.
If Yuki 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 Yuki later in the manual.
After the order has been forwarded and a success message from Yuki has been received, the order is marked as handled. The Opencart order appears at the Reporting tab on the dashboard.
If Yuki 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 Yuki 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.
Read more Required Opencart ....
Read less Required Opencart ....
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.Required: Yuki codes
The Yuki website explains how to generate an access code for the integration for your Yuki administration code as a user with a direct role. The access code is the 'webservices API key' generated in Yuki.
Read more Required Yuki ....
Read less Required Yuki ....
5.Installation
After installation, check using this FAQ, whether the integration works.
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 Yuki. This authorizes the integration to write transactions to your Yuki administration and read information.
3. Configuring additional data, such as the VAT settings.
Before the integration can be used, the terms and conditions must first be accepted. The terms and conditions are based on the general ICT Terms and Conditions (industry organization) and the general GDPR guidelines. We also need a name, email address, and the country of the webshop. 
Authentication OpenCart webshop:
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.
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.
Connection Yuki
You establish the connection with Yuki using the administration ID and API key determined in the previous step. Click the red Connect button next to Yuki. You can then enter the administration ID and API key in the pop-up window.
Configure VAT rates and general ledger accounts
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 Yuki. 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.
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 Yuki. 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.
Configure payment methods
Here you can create a link between the payment methods in webshop and a clearing account and fixed debtor in your Yuki administration. Orders with a payment method from the list will then always be booked under this debtor and to the clearing account. 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 Yuki for an ICP order.
Here you can create a link between the payment methods in webshop and a clearing account and fixed debtor in your Yuki administration. Orders with a payment method from the list will then always be booked under this debtor and to the clearing account. 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 Yuki for an ICP order.
6.Day-to-day: From OpenCart
In this section, we show how we retrieve the orders from the webshop.
Processing schedule: New orders from your webshop are retrieved at least once per hour. In addition, every night the orders that were previously retrieved and not yet forwarded to your accounting system are reviewed. An order is processed depending on the status of that order. You can use the dashboard, tab Configuration, set at which statuses orders should be processed.
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 Yuki.
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 Yuki.
VAT calculation: The VAT setup of OpenCart is complex and the work of specialists. For OpenCart VAT, the geozone IDs, tax rules, and tax rates must be correctly configured, especially if you deliver to multiple countries. Unfortunately, we do not provide support for the VAT setup of the OpenCart webshop.
7.Day-to-day: To Yuki
Create transactions
A order from the Opencart webshop is processed to Yuki as a Yuki invoice. The draft invoice option is default and is used most frequently. The processed invoice option can be requested from us. For both options, you need the paid sales module in Yuki.
By default, the integration places the unit price and quantity in the Yuki invoice lines. Yuki will calculate the line totals itself. This may result in rounding differences. If these rounding differences are unacceptable, the integration can, via a special contract setting, also include the line totals. In that case, the line totals are leading in Yuki.
This method is not standard because Yuki generally discourages it and only makes exceptions for specific situations.
Create debtor
When processing customer information, the data is included in the sales transaction and Yuki will handle further processing. The invoice address is included, even if the shipping address is different.
Field-level specification Yuki
A order from the Opencart webshop is processed to Yuki as a Yuki invoice. The draft invoice option is default and is used most frequently. The processed invoice option can be requested from us. For both options, you need the paid sales module in Yuki.
By default, the integration places the unit price and quantity in the Yuki invoice lines. Yuki will calculate the line totals itself. This may result in rounding differences. If these rounding differences are unacceptable, the integration can, via a special contract setting, also include the line totals. In that case, the line totals are leading in Yuki.
This method is not standard because Yuki generally discourages it and only makes exceptions for specific situations.
Create debtor
When processing customer information, the data is included in the sales transaction and Yuki will handle further processing. The invoice address is included, even if the shipping address is different.
Automatically sending invoices
The integration creates the invoice in Yuki. The invoice will not be sent automatically from Yuki. We can adjust this so that the invoice is sent automatically. Please contact us at webcare@webwinkelfacturen.nl if you would like to make use of this option.
The integration creates the invoice in Yuki. The invoice will not be sent automatically from Yuki. We can adjust this so that the invoice is sent automatically. Please contact us at webcare@webwinkelfacturen.nl if you would like to make use of this option.
Field-level specification Yuki
Field-level specification of the Yuki invoice. +-
| Name | Example | Note |
| SalesInvoice | ||
| Reference | 9483 |
Opencart orders:
|
| Subject | Order 9483 |
|
| PaymentMethod | Online | The payment method, as set in the Configuration tab. |
| Process | true | Can be True or False |
| EmailToCustomer | false | Default false. Upon request this can be set to true, but only if transactions are processed with status “Processed”. In that case, the invoice will automatically be sent from Yuki to the customer. This option is not available for the Yuki minimal bundle. |
| SendToPeppol | false | Default false. Upon request this can be set to true, but only if transactions are processed with status “Processed”. This option is only available for Yuki bundle customers. Within the Yuki administration, the VAT number and Chamber of Commerce (KvK) number must be filled in for the customer. These must therefore be available. |
| Layout | Name of the invoice layout in Yuki. If you would like the integration to use a specific invoice layout from Yuki, please provide us with its name and we will configure it for you. | |
| Date | 2023-03-01 | order date |
| PriceList | Default empty, not editable. | |
| Currency | EUR | This option is disabled by default. You can contact us if you would like to make use of this. |
| Remarks | [notes] | |
| Contact | ||
| FullName | Sophie Fischer | first name last name |
| FirstName | Sophie | first name |
| LastName | Fischer | last name |
| Gender | Unknown | |
| CountryCode | NL | landcode |
| City | Amsterdam | city |
| Zipcode | 1000AA | zipcode |
| AddressLine_1 | Stationstraat 12 | address |
| AddressLine_2 | House | |
| Website | Default empty, not editable. | |
| CoCNumber | Chamber of Commerce number (KvK number) | |
| VATNumber | VATnumber | |
| ContactType | Person | |
| ContactPerson | ||
| FirstName | Sophie | first name |
| LastName | Fischer | last name |
| Gender | Unknown | |
| EmailAddress | sophie@webwinkelfacturen.nl | |
Field-level specification of Yuki invoice lines. +-
| Name | Example | Note |
| InvoiceLines | ||
| InvoiceLine | ||
| ProductQuantity | 1 | Amount |
| LineAmount | 29.56 | Line amount incl. VAT. Available on request only and with the contract setting push_lineprices enabled. Yuki will then use the line amount and ignore the unit prices. |
| LineVATAmount | 5.13 | VAT line amount. Available on request only and with the contract setting push_lineprices enabled. Yuki will then use the line amount and ignore the unit prices. |
| Product | ||
| Description | Flip-flops size 7 | ProductName |
| Reference | SKU if available | |
| Category | ||
| SalesPrice | 29.56 | Price per piece incl VAT |
| VATPercentage | 21 | VAT percentage |
| VATIncluded | true | |
| VATType | 1 | Based on the settings in the dashboard. A fixed list is used for the VAT codes. |
| GLAccountCode | 700800 | General ledger account - this cannot be disabled. |
| Remarks | ||
8.Support
We believe it is important that you as online retailer have direct access to information about the integration whenever you want. That is why every customer has a personal dashboard.
Read more Support .... Read less 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 Yuki.At Dashboard >> Errors you can see which orders have not been processed. Via the blue Process button you can (re)submit the order. Via the red Report problem button you can create a ticket with us.
At Dashboard >> Open the orders are listed that have not yet been processed because they do not yet have the correct status in the webshop. Every night jobs run to review the status again and still process the order.
At Dashboard >> Configuration the settings of your integration are listed. You can adjust the settings there.
At Dashboard >> Profile invoices are available for download. You can also specify an additional email address here for sending emails and stop the integration.
What if orders are missing in Yuki
If orders are missing in Yuki 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 Yuki (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.
You can send any other questions or comments to webcare@webwinkelfacturen.nl. For a quick response, please always include the license key and as much information as possible. If you encounter any problems during installation, please let us know where you're experiencing the issue. And if there's an error message, please include that as well. If you think orders is missing, please provide the number and date. This way, we can perform a more targeted search and tell you what's wrong.
We have an extensive FAQ-section on the website. Pay particular attention to these sections: https://faq.webwinkelfacturen.nl/category/26/opencart.html and https://faq.webwinkelfacturen.nl/category/43/yuki.html.
Would you rather have us do the installation of the integration for you? That is possible. Send an email to webcare@webwinkelfacturen.nl with the request. For an installation, we charge € 39.50 excl. VAT. For installations, we need access to the webshop and the accounting system.
We can perform migrations for orders that took place in the past. The request procedure and method are described in this faq. For migrations we charge €67.50 excl. VAT per 1000 orders.