1.Introduction
This is the manual for the integration between Prestashop and Yuki.
- 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 Prestashop and in the FAQ for Yuki.
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 in Prestashop when uninstalling the integration.
2.How the integration works
New orders from your webshop are retrieved at least once per hour. If they have the correct status, they are processed to Yuki. You can set the statuses via the dashboard, tab Configuration.
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 Prestashop order:
- It is checked whether the total of the Prestashop 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.
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.
After the order has been forwarded and a success message from Yuki has been received, the order is marked as handled. The Prestashop 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: Prestashop API key
To create the API key in your PrestaShop webshop, go to Advanced parameters - Web services via the menu.
Click on Add New to create a new API key.
If you click Generate on the next screen, an API key will be automatically generated. You can also create an API key yourself, but it is safer to let the system do it. Also provide a description so that you know later what you are using the API key for.
Finally, you need to set the permissions for the API key. The integration only wants to read from the PrestaShop webshop. So, only select View permissions for the following items:
addresses
categories
countries
customers
order details
orders
order state
producten
statussen
taxes
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.
5.Installation
After the 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 Prestashop 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.
Read more Installation ....Read less Installation ....
Authentication with your PrestaShop webshop is done via the API key you created in a previous section. Click the red Connect button next to PrestaShop 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 web service is enabled in the PrestaShop webshop.
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.
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.
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 PrestaShop
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 Yuki.
Please note: Due to the load on our systems, we go back a maximum of 3 months in time to check the status of orders and process them anyway. In addition, the number of orders that can be checked is limited to 300. Therefore, ensure that orders are completed in a timely manner so that the integration can process them and you do not have to manually re-enter them.
Field-level specification orders
| Below is an elaboration at field level when retrieving orders. The general values in the order, the order lines, discounts, surcharges are addressed, the shipping costs and the debtor details. | |
| Name field | Values from Prestashop order |
| Order-identifier | [id] |
| Order number | [reference] |
| Invoice number | [invoice_number] |
| Date | [date] |
| Order date | [date_add] |
| Status order | [current_state] |
| Payment method | [payment_details][method_title] |
| Total VAT order | [price][tax][amount] or - if [price][tax] consists of multiple lines, the sum of the [amount] fields of the [price][tax] lines |
| Order total incl VAT | [total_products_wt + total_shipping_tax_incl + total_wrapping_tax_incl - total_discounts_tax_incl] |
| Order total excl VAT | [total_products + total_shipping_tax_excl + total_wrapping_tax_excl - total_discounts_tax_excl] |
| Total VAT order | Order total incl - Order total excl |
| Delivery country | [], please note that the country of delivery is NOT used here. |
| ICP indication | The integration determines as follows whether it concerns an ICP order:
|
| International indication | The integration determines as follows whether it concerns an international order:
|
| To read the order lines, the integration takes the field [orderlines]. In Prestashop, order lines have different types. These are indicated by the field [type]. For the order lines, this concerns type article or type [custom]. | ||
| Name field | Values from Prestashop order line | |
| Productid | [articles][0][id] | |
| Amount | [quantity]. Please note, if the quantity is 0, the line is skipped. | |
| SKU | [articles][0][sku] if it is filled. If not, the product is retrieved from Prestashop and the SKU is determined based on that. | |
| Description | [description] | |
| VAT percentage | [price][rate], if smaller than 1, the VAT percentage is multiplied by 100. | |
| Line amount excl VAT | Amount in the field [price][amount] | |
| Line amount incl VAT | Amount in the field [price][amount_including_tax] | |
| Unit amounts | Divide the line item amounts by the amount | |
| VAT code and accounts Yuki | These are determined based on the settings, the VAT percentage and the delivery country. It also takes into account whether it is an ICP or international order. | |
| Only the payment method and possibly the set debtor are retrieved here. Payment costs are not in the Prestashop order, so they cannot be processed either. | ||
| To read the order lines, the integration takes the fields total_discounts_tax_excl] and total_discounts_tax_incl]. This concerns a discount on the entire order. The integration calculates the discount proportionally back to the VAT percentages in the shopping cart. | ||
| Name field | Values from Prestashop discountline | |
| Amount | 1 | |
| Description | Discount < |
|
| Line amount incl VAT | Relative with value [total_products_wt] | |
| Line amount excl VAT | Relative with value [total_products_wt] and the VAT percentage | |
| VAT code and accounts Yuki | These are determined based on the settings, the VAT percentage and the delivery country. It also takes into account whether it is an ICP or international order. | |
| Name field | Values from Prestashop surcharge-fields |
| Amount | 1 |
| Description | Surcharge |
| Amount excl VAT | [total_wrapping_tax_excl] |
| Amount incl VAT | [total_wrapping_tax_incl] |
| VAT amount | [total_wrapping_tax_incl] - [total_wrapping_tax_excl] |
| VAT percentage | Amount incl - Amount excl A percentage greater than 0.204 and smaller than 0.21 is rounded to 21%. |
| VAT code and accounts Yuki | These are determined based on the settings, the VAT percentage and the delivery country. It also takes into account whether it is an ICP or international order. |
| Name field | Values from Prestashop customer |
A customer's addresses must be retrieved separately in the webshop. This works as follows:
|
|
| Customer |
Customer fields
|
| Address |
Address-fields
|
7.Day-to-day: To Yuki
A order from the Prestashop 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.
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
| Name | Example | Note |
| SalesInvoice | ||
| Reference | 9483 |
Prestashop 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 | |
| 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
Read more Support .... Read less Support ....
Explanation tabs dashboard
On the Dashboard >> Report you can see which orders from your Prestashop webshop, and when, have been transferred to Yuki.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.
