1.Introduction
This is the manual for the integration between Lightspeed eCom 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 Lightspeed eCom and in the FAQ for Yuki.
You install this integration from the Lightspeed eCom App Store. If you select the Accounting category, our apps will appear automatically. You can recognize us as a supplier by the blue area and the white gear icon at the top right. If you click on the App, you will see a description and the Install button. Upon activation, you will be automatically guided through the configuration screens.
The installation is complete when both connection dots are green, and the settings in the Configuration tab have been entered and saved.
Important: Once the integration is installed, always log in to the dashboard via https://uwkoppeling.webwinkelfacturen.nl, and not from the app store.
The trial period for the integration is 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.
If you want to terminate the integration, you can simply remove the app from the app store in your backend.
Are you switching to another accounting system and want to create a new integration? You can install the new app from the app store in your backend. Make sure you are logged out of the dashboard of the old integration and preferably start the new installation in an incognito browser.
Are you switching to another webshop system? Via our integrations page you can see whether you install it from the relevant app store, or by means of an installation link.
Has the installation been successful, but do you see in the dashboard of the integration the old license key still present when you click the dropdown arrow next to the key (even though that app/key has been deleted)? If so, please send us an email requesting that the old key be removed.
2.How the integration works
The integration works with webhooks from the Lightspeed eCom webshop. Processing can be done in two ways, namely based on paid orders or invoices. The advantage of the option paid orders is that orders that are not paid do not enter the accounting system. With this option, however, credit notes are not included. With the option invoices all invoices are processed to Yuki, so both debit and credit invoices. You can set the preference for paid orders or invoices via the Configuration tab of the dashboard.
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 Lightspeed eCom order or invoice:
- It is checked whether the total of the Lightspeed eCom order / invoice is equal to the sum of the amounts in the order / invoice lines plus the shipping costs amount.
- If the order / invoice is an ICP sale, 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 or invoice has not already been processed.
Processing orders or invoices
If the check is successful, the order or invoice will be processed to Yuki.
The debtor details are placed in the Yuki invoice. Yuki itself processes the debtor details.
After the order or invoice has been forwarded and a success message from Yuki has been received, the order or invoice is marked as handled. The Lightspeed eCom order appears at the Reporting tab on the dashboard.
If Yuki returns an error while processing the order or invoice, the order or invoice 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 or invoice 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 or invoices 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: 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.
4.Installation
The integration between Lightspeed eCom and yuki is installed via the Lightspeed App Store. First, the connection with your webshop is established and you authorize the integration to read data from your webshop.
Read more Installation .... Read less Installation ....
Two more steps need to be completed:
1. Establishing the connection with Yuki. This authorizes the integration to write transactions to your Yuki administration and to read information.
2. The configuration itself.
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, the integration shows a fixed list of VAT rates per EU country. You can configure this fixed list. If you provide OSS, you can easily adjust the list with the correct VAT percentage per country. If you prefer to use the VAT rates from your webshop, you can adjust this in the contract settings. 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 or invoices 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 or invoices. For an ICP order or invoice, a valid VAT number must be transmitted. Therefore, a debtor will always be created in Yuki for an ICP order or invoice.
5.Day-to-day: From Lightspeed
VAT numbers: For business orders within the EU, outside the Netherlands, a VAT number is mandatory. The integration performs a check on the validity of VAT numbers.
Field-level specification orders
| Below is an elaboration at field level when retrieving orders. The general values in the order and the order rules are discussed, the shipping costs and the debtor details. | |
| Name field | Values from Lightspeed eCom order |
| Order-identifier | [id] |
| Order number | [ordernumber_full] |
| Affiliate number | This must be requested separately by the merchant. The field [comment] is used for this. |
| Customer number | [customer][resource][id], this is not used |
| Order and booking date | [createdAt] |
| ICP indication |
An order is an ICP order if:
|
| International indication |
An order is an international order if:
|
| Order status | [status] |
| Payment status | [paymentStatus] |
| Payment method | [paymentTitle] |
| Paymentmethod-id | [paymentId] |
| Total amounts excl VAT | [priceExcl] |
| Total amounts incl VAT | [priceIncl] |
| Total VAT | Total incl - Total excl |
| Total discounts incl or excl VAT | The amounts in the order can be incl. or excl. VAT. This is determined by the field [order_row_taxes_included] |
| Total discounts | 0 |
| Name field | Values from Lightspeed eCom order |
| VAT percentage | [taxRate] * 100 |
| Name product | The name of the product is determined as follows
|
| SKU | [sku] |
| Ean | [ean] |
| Productcode | [articleCode] |
| Amount | [quantityOrdered] |
| Discount excl / incl VAT | [discountExcl] / [discountIncl] |
| Line amounts incl or excl VAT without discount | [basePriceExcl] / [basePriceIncl] * quantity |
| Line amounts incl or excl VAT with discount | [priceExcl] / [priceIncl] |
| Unit amounts incl or excl VAT without discount | [basePriceExcl] / [basePriceIncl] |
| Unit amounts incl or excl VAT with discount | [priceExcl] / [priceIncl] divide by the quantity |
| Accounts and VAT codes from Yuki | These are determined based on the settings in the integration, the delivery country of the order and the VAT percentages. The type for order lines is turnover / revenue. |
| Name field | Values from Lightspeed eCom order |
| Name | Shipping costs [shipmentTitle] |
| VAT percentage | [shopmentTaxRate] * 100 |
| Shipping costs incl or excl VAT without discount | [shipmentBasePriceExcl] / [shipmentBasePriceIncl] |
| Discount Shipping costs incl or excl VAT | [shipmentDiscountExcl] / [shipmentDiscountIncl] |
| Shipping costs incl or excl VAT with discount | [shipmentBasePriceExcl] / [shipmentBasePriceIncl] minus [shipmentDiscountExcl] / [shipmentDiscountIncl] |
| Accounts and VAT codes from Yuki | These are determined based on the settings in the integration, the delivery country of the order and the VAT percentages. The type for shipping costs is shipping / shipping costs. |
| Name field | Values from Lightspeed eCom order |
| Name | Payment costs [paymentTitle] |
| VAT percentage | [paymentTaxRate] |
| Payment costs incl and excl VAT | [paymentBasePriceExcl] / [paymentBasePriceIncl] |
| Accounts and VAT codes from Yuki | These are determined based on the settings in the integration, the delivery country of the order and the VAT percentages. The type for payment costs is payment / payment costs. |
| Name field | Values from Lightspeed eCom order |
| First name | [first_name] |
| Last name | [last_name] |
| Company name | [companyName] |
| Phone number | [phone] |
| Chamber of Commerce number | [companyCoCnumber], a clean-up action takes place here |
| Address line 1 | [addressBillingStreet] [addressBillingNumber] [addressBillingExtension] |
| Address line 2 | [addressBillingStreet2] |
| Zip code | [addressBillingZipcode] |
| City | [addressBillingCity] |
| Country | [addressBillingCountry][code], and the name is determined based on that code |
| Iso country | [addressBillingCountry][code] |
| Shipping address | Same as for the billing address, but now with [addressShipping] instead of [addressBilling] |
| VAT number | [companyVatNumber] - this is checked for correctness |
| Emailaddress | [email] |
Field-level specification invoices
| Below is a specification at field level for retrieving invoices. The debtors from the invoice are read in the same way as for orders. The fields are listed above. | |
| Name field | Values from Lightspeed eCom invoice |
| Invoice-identifier | [id] |
| Invoice number | [number] |
| Order-identifier | [id] of the order associated with the invoice |
| Affiliate number | This must be requested separately by the merchant. The field [comment] is used for this. |
| Invoice date | [createdAt] |
| ICP indication |
An order is an ICP order if:
|
| International indication |
An order is an international order if:
|
| Payment status | [paymentStatus] |
| Payment method | [paymentTitle] |
| Paymentmethod-id | [paymethodId] |
| Total amounts incl or excl VAT | [priceIncl] and [priceExcl] |
| Total VAT | [priceIncl] - [priceExcl] |
| Similar to retrieving customer data from the order, see above. |
| The invoice lines in the Lightspeed invoice have a type. The lines with type equal to product or custom are designated as invoice lines. These invoice lines are processed one by one. | |
| Name field | Values from the Lightspeed eCom invoice line |
| VAT percentage | [taxRate] * 100 |
| Name product | The name of the product is determined as follows
|
| SKU | [sku] |
| Ean | [ean] |
| Productcode | [articleCode] |
| Amount | [quantity] |
| Discount excl / incl VAT | [discountExcl] / [discountIncl] |
| Line amounts incl or excl VAT without discount | [basePiceExcl] / [basePriceIncl] * [quantity] |
| Line amounts incl or excl VAT with discount | [priceExcl] / [priceIncl] |
| Unit amounts incl or excl VAT without discount | [basePriceExcl] / [basePriceIncl] |
| Unit amounts incl or excl VAT with discount | [priceExcl] / [priceIncl] divide by [quantity] |
| Accounts and VAT codes from Yuki | These are determined based on the settings in the integration, the delivery country of the invoice and the VAT percentages. The type for invoice lines is turnover / revenue. |
| The invoice lines in the Lightspeed invoice have a type. The lines with type equal to shipment. The integration expects a maximum of 1 shipping line. | |
| Name field | Values from the Lightspeed eCom shipping line |
| VAT percentage | [taxRate] * 100. If the VAT percentage is 0, it is checked whether the VAT percentage can be determined from [basePriceIncl] and [basePriceExcl] |
| Name | Shipping costs [variant] |
| Amount | 1 |
| Discount excl / incl VAT | [discountExcl] / [discountIncl] |
| Line amounts incl or excl VAT without discount | [basePiceExcl] / [basePriceIncl] |
| Line amounts incl or excl VAT with discount | [priceExcl] / [priceIncl] |
| Unit amounts incl or excl VAT without discount | [basePriceExcl] / [basePriceIncl] |
| Unit amounts incl or excl VAT with discount | [priceExcl] / [priceIncl] |
| Accounts and VAT codes from Yuki | These are determined based on the settings in the integration, the delivery country of the invoice and the VAT percentages. The type for shipping lines is shipment / shipping costs. |
| The invoice lines in the Lightspeed invoice have a type. The lines with type equal to payment. The integration expects a maximum of 1 payment line. | |
| Name field | Values from the Lightspeed eCom payment line |
| VAT percentage | [taxRate] * 100. If the VAT percentage is 0, it is checked whether the VAT percentage can be determined from [basePriceIncl] and [basePriceExcl] |
| Name | Payment costs [variant] |
| Amount | 1 |
| Discount excl / incl VAT | [discountExcl] / [discountIncl] |
| Line amounts incl or excl VAT without discount | [basePiceExcl] / [basePriceIncl] |
| Line amounts incl or excl VAT with discount | [priceExcl] / [priceIncl] |
| Unit amounts incl or excl VAT without discount | [basePriceExcl] / [basePriceIncl] |
| Unit amounts incl or excl VAT with discount | [priceExcl] / [priceIncl] |
| Accounts and VAT codes from Yuki | These are determined based on the settings in the integration, the delivery country of the invoice and the VAT percentages. The type for payment lines is payment / payment costs. |
6.Day-to-day: To Yuki
A order or invoice from the Lightspeed eCom 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 |
Lightspeed eCom orders:
Lightspeed eCom invoices:
|
| Subject | Order or invoice 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 | ||
7.Support
Read more Support .... Read less Support ....
Explanation tabs dashboard
On the Dashboard >> Report you can see which orders or invoices from your Lightspeed eCom webshop, and when, have been transferred to Yuki.What if orders or invoices are missing in Yuki
If orders or invoices 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 or invoice is there. You may need to adjust the search period if the
order or invoice is from a previous month. If you find order or invoice 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 or invoice.
- 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 or invoice 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 or invoice.
- Go to the Open tab and check if order or invoice is there.
- If you cannot resolve the issue, you can always create a ticket via the green Ask us button.
