1.Introduction
This is the manual for the integration between Shopify and Asperion.
Are you using the Shopify POS then the sales from this POS of one day can be placed as one daily invoice in Asperion. This option can be requested via webcare@webwinkelfacturen.nl. Additional costs are associated with this option. It is also possible to process payments for the Shopify orders to Asperion. Processing payments can be requested via webcare@webwinkelfacturen.nl. Additional costs may be charged.
- This integration is a financial integration. It is not a logistics integration. The integration is not suitable for updating customers in Asperion, printing packing slips, or synchronizing products/inventory. The integration works only with the payment status in the Shopify order, where you can configure which statuses should trigger forwarding the order (for example 'processing', 'paid' / 'refund'; multiple statuses are possible).
- An order is forwarded to Asperion only once. Changes made after the order has been forwarded will not be applied in the accounting system. Any adjustments must therefore be handled via the refund process in Shopify or updated manually in Asperion.
- 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 Shopify and in the FAQ for Asperion.
You install this integration from the Shopify App store. If you search for webwinkelfacturen, our apps will appear automatically. You can recognize us as a supplier by the blue gear icon. If you click on the App, you will see a description and the Add app button. Upon activation, you will be automatically guided through the configuration screens.
When you click the Add app button, you must first authorize the integration to read and possibly even write data from your webshop. This is indicated in the next screen. You also need to approve the monthly fee for the integration. Once you have approved the monthly fee, the connection with Shopify is established and you will be automatically redirected to your personal dashboard.
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 via the appstore
There is a 30-day free trial.
The integration is a real-time integration. Once an order has reached a certain status, it will be processed to your accounting system as quickly as possible.
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
Shopify works with webhooks. We receive a notification whenever a new order is created in your webshop or when an order is changed. If the order order can be processed—this depends on the status—the integration places the order order in the processing queue. Depending on the processing queue's volume, the order will be processed quickly or slightly later. Generally, queues move quickly.
In addition to the webhooks, a sweep is done daily. This means that the integration checks daily whether all webhooks have been received correctly. If any webhooks are missed, those orders are still retrieved and forwarded.
Read more How the integration works .... Read less How the integration works ....
Note: Foreign orders are never part of the daily invoice. Foreign orders are orders delivered outside the country of the webshop. If a daily invoice is chosen, payments can no longer be processed separately. That option will no longer be available.
At the start of processing an order, we perform a number of checks on the Shopify order:
- It is checked whether the total of the Shopify 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 Asperion for the VAT in each line.
- It is checked whether the order has not already been processed.
A payment is only added if the status of the payment is succes. A payment is only processed if the corresponding order has been processed first.
Processing a Shopify order to Asperion takes place in three steps:
- It is checked if the customer already exists in Asperion. If not, the customer is created. Matching is based on the email address.
- When processing to Asperion invoices incl. products, it is checked whether the products from the Shopify order are already present in Asperion. Missing products are added to Asperion.
- The Asperion invoice or sales entry is created and added.
Because the integration created the Asperion invoice for the Shopify sale, the Asperion invoice is known. The payment entry is created for this invoice and processed to Asperion. Note: The invoice in Asperion must be processed. The payment entry cannot be processed if the invoice still has a draft status.
After the order has been forwarded and a success message from Asperion has been received, the order is marked as handled. The Shopify order appears at the Reporting tab on the dashboard.
If Asperion 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.
When forwarding the payment, the payment is also registered so that it cannot be processed again. Payments can also be reviewed via the dashboard.
Data
Information about the data that is processed can be found in the section Day-to-day: To Asperion later in the manual.
3.Required: Asperion connection
The connection to Asperion is established via OAuth. You can easily set up this connection via the Configuration tab on the dashboard https://uwkoppeling.webwinkelfacturen.nl. An image of this is included in the following section.
If you wish to switch to Asperion invoices including products, the integration will add a product if it does not yet exist. The integration will use the revenue accounts configured via the dashboard https://uwkoppeling.webwinkelfacturen.nl as far as possible, but it may happen that the revenue account cannot be determined.
In that situation, the integration will use a default Sales Type SHOPORDER. Ensure that this Sales Type is available in your Asperion account. The image below shows how to add the SHOPORDER Sales Type.
4.Installation
Activating the integration now continues with:
1. Accepting the terms and conditions.
2. Establishing the connection with Asperion. This authorizes the integration to write transactions to your Asperion administration and read information.
3. The configuration itself.
Read more Installation ....Read less Installation ....
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.
Authentication Asperion
The authentication with Asperion runs via OAuth. Make sure you are logged out of Asperion before starting the connection. You now click on the red Connect button. A login screen for your Asperion account will automatically appear. When you log in, you will get a screen asking if you allow the connection. If you confirm this, the connection with Asperion is established.
If you want to re-establish the connection at a later time—for example, because you want to connect via a different Asperion user—you can always do so by clicking the Connect button.
You can specify which statuses orders should be processed to Asperion. You can select multiple statuses. The integration will never forward orders twice. The integration is protected against this.
To use Asperion, select an administration within your account.
You can also set a payment condition for new debtors. One payment condition is possible per integration, and setting a payment condition is mandatory.
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 Asperion. You can always make changes by clicking the blue 'Edit' button and selecting an option from the drop-down menus.
In the VAT rates, the integration shows a standard list of VAT rates and all EU countries. By default, the Dutch or Belgian VAT rates are filled in. The VAT percentages can be adjusted. For example, in the case of OSS, the German high VAT percentage can be adjusted to 19%.
It is possible to work with the VAT rates in the webshop. You can adjust this at the Configuration tab of the dashboard, under the option All Settings > Contract. 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 Asperion 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 Asperion for an ICP order.
Please note: Unfortunately, Shopify does not allow us to read the payment methods you use in your webshop. Therefore we work with a fixed list of payment methods. It may be that there are payment methods listed that you do not use and that there are payment methods not listed that you do use. There is a workaround for this, described in this faq.
When processing payments, a clearing account of type Payment methods is set in Asperion. When setting up the clearing accounts, there is no (longer a) possibility to post to fixed debtors per payment method.
It is possible to process revenue based on product categories. You can configure the general ledger accounts here. We recommend a maximum of 40 categories, and there is a technical maximum of 99 categories. When accounts are configured at the category level, they take precedence. The revenue accounts set under the VAT rates will no longer apply.
5.Day-to-day: From Shopify
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 Asperion.
The integration performs an extra check for orders in the Shopify webshop that are loaded from Bol.com or Amazon. This loading happens via an external app that the Shopify merchant can enable. For these imported orders, the integration performs an extra check whether the VAT is present in the order. If not, the order will not be processed. See our FAQ for more information.
Old orders processing
It is possible to process orders that are already in the Shopify webshop via a migration. You can request this via webcare@webwinkelfacturen.nl. We ask a modest fee for this. We cannot process orders from more than two years ago.
Note: Because the Shopify integration works with webhooks, you should not import orders retroactively in your Shopify webshop after activating the integration. If you do this and for example import 500 orders at once or change the status of 500 orders, our platform will receive all these changes and start processing them. This creates a disproportionate load on our network.
Processing daily revenue
When processing daily revenue, the integration retrieves the receipts from the previous day from the POS system in the morning. The integration combines these receipts into one daily invoice and places it in Asperion.
Payments (if activated)
When processing payments, the integrations checks daily the Shopify orders that have been successfully processed to Asperion. If the order has a valid payment—a transaction with the success status—then that payment will also be processed to Asperion. Checking Shopify orders is performed six times per day.
Note: The integration does NOT process payments for returns. This is because returns often don't go through the payment integrations, resulting in incorrect payments being processed in Asperion.
If you want the integration to process refunds in addition to orders, you can enable the status refund or partially_refunded in the Configuration tab under Status process sales. Refunds must be created correctly in Shopify, meaning the refund must be applied to the order lines. Unfortunately the integration cannot process a refund that only contains an amount. For more information see: FAQ.
Please note: For refunds, the integration goes back a maximum of 30 days in time. Also, the integration only processes a refund if the integration has previously processed the order to which the refund relates.
The integration will not read or pass many fields from a Shopify order to Asperion. In particular, the note_attribute fields and the custom fields are not included. This is because different webshops use these fields differently. Because our integrations must work for all webshops, we cannot configure this for individual merchants.
Pay special attention to fields that are added via a plugin. There is a significant chance that the integration will not process these fields.
| 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 Shopify order | |
| Order-identifier | [id] | |
| Order number | Is determined as follows:
|
|
| Invoice number | Is determined as follows:
|
|
| Booking date | [created_at] | |
| Order date | [processed_at] | |
| Status order | [financial_status] | |
| Payment status | if the status of the order is paid then paid, otherwise no payment status | |
| Payment reference | [order_number] | |
| Affiliate number | Is determined as follows
|
|
| Valuta | [currency] if present | |
| Payment method | field [gateway] in [transactions] | |
| Order total incl. VAT and discounts | [total_price] | |
| Total VAT order incl. discounts | Value in [total_tax], or, if that value is 0, the value from [current_total_tax]. When using [current_total_tax], there's an additional check. The VAT lines in the order must add up to the value in [current_total_tax]. | |
| Order total excl. VAT and discounts | Difference between the two lines above | |
| 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:
|
|
| Discounts |
Discounts are determined as follows:
|
|
| To read the order lines, the integration retrieves the [line_items] field. Multiple order lines can be included in the order, and the integration reads these lines one by one. | ||
| Name field | Values from Shopify order line | |
| Productid | [product_id] | |
| categoyid | Category associated with the product | |
| Amount | [quantity] | |
| SKU | [sku] | |
| Description | [name] | |
| VAT percentage |
The VAT percentage is determined as follows:
|
|
| Amounts excl. VAT |
The amounts excluding VAT are determined as follows:
|
|
| Amounts incl. VAT |
The amounts including VAT are determined as follows:
|
|
| Discount in order line |
The discount in the order line is determined as follows:
|
|
| VAT code and accounts Asperion | These are determined based on the settings, the VAT percentage and the delivery country. This also takes into account whether it is an ICP or international order. When processing by categories, the revenue account of the category is used. This can be set via the dashboard. | |
| To read the shipping costs, the integration uses the field [shipping_lines]. There can be multiple shipping lines. For the name and VAT percentage only the first line is used, while the amounts from all shipping lines are summed. In most cases there will be only one shipping cost line. | ||
| Name field | Values from Shopify order line | |
| Description | [title] from the first shipping cost line | |
| VAT percentage | Sum of the values in field [rate] from the [tax_lines] in the first shipping cost line. | |
| Shipping costs excl VAT |
The shipping costs excluding VAT are determined as follows:
|
|
| Shipping costs incl VAT |
The shipping costs including VAT are determined as follows:
|
|
| VAT code and accounts Asperion | 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 Shopify customer |
| If present [email] otherwise [contact_email] | |
| Invoice address |
If present based on [billing_address] in the Shopify order
If there is no billing address and no shipping address, the information in [customer] and [customer][default_address] is checked. |
| Shipping address |
If present based on [shipping_address] in the Shopify order
|
| VAT number |
The VAT number is determined as follows:
|
| This is used when payments are processed separately to Asperion. This option can be requested via webcare@webwinkelfacturen.nl. Additional costs are associated with this option. | |
| To determine the payment details, the integration uses the field [transactions]. Multiple payments may have been made for an order, so with multiple payment methods. At this moment, only the first payment is used, so [transactions][0]. | |
| Name field | Values from Shopify order |
| The paid amount | [amount] |
| Valuta | [currency] |
| Payment method | [gateway] |
| Status | [status] |
| Transaction-id | [authorization] |
| Payment date | [processed_at] |
6.Day-to-day: To Asperion
For orders in Shopify, sales entries or invoices can be created in Asperion. Invoices are the default. If you prefer to process to sales entries, you can configure this on the dashboard, Configuration tab. When processing to invoices in Asperion, the integration posts to the products in Asperion. This does not happen when processing to sales entries.
The invoices in Asperion are always created with draft status. Unfortunately, it is not possible to set the invoices in Asperion to paid.
Create payments
For orders in Shopify, payment transactions are created in Asperion. The payment transaction consists of two lines, one line for the payment and one for the associated invoice. To create a payment transaction, the corresponding invoice must therefore already be in Asperion.
Create debtors
When processing customer information, it is first checked whether the customer has been processed before. If so, this Asperion debtor is used as the debtor for the Asperion invoice or sales entry. If the customer is not yet known, they are added to Asperion.
Matching is based on email address. Please note: The integration only creates debtors. The integration does not modify debtors.
Create products
This only applies when processing to Asperion invoices. When creating a new product, the integration will, where possible, use the revenue account configured in the dashboard. If the revenue account cannot be determined, products will be assigned a default sales type SHOPORDER. Therefore, ensure this sales type is present in your Asperion account.
Please note: The integration only creates products. The integration does not modify products.
When processing to Asperion invoices, products in the sales lines will be looked up in Asperion. When posting to Asperion invoices, the SKU of the Asperion product will be included in the lines of the Asperion invoice. No separate revenue account is provided in the Asperion invoice lines, as that revenue account is already associated with the product in Asperion. This means that if a product is not yet present in Asperion, the integration will create this product using a revenue account from the settings.
The rules for matching products between Shopify and Asperion can be found in this FAQ read here.
Extra warning: In Shopify orders, EAN (barcode) and item code are not provided in the order lines. Therefore, the EAN and the item code cannot be used for matching products in Asperion.
The integration creates the invoice in Asperion with the status draft. The invoice must first be processed in Asperion. Only then can the invoice be sent to the customer. Therefore, the integration cannot ensure that sending happens automatically.
Field level specification creating Asperion invoice / sales transaction
| Below is an specification at field level for the creation of an invoice or sales transaction. | |
| Name field | Values from Shopify order |
| Date | orderdate |
| Customer number | [debtorcode] from Asperion |
| Subject / Reference | This field is composed of the order number and/or (credit) invoice number
|
| Company - invoice | Company name in the invoice address |
| For the attention of - invoice | First name Last name in the invoice address |
| Address - invoice | Invoice address house number in the invoice address |
| Postcode - invoice | Postcode in the invoice address, max length 10 |
| City - invoice | City in the invoice address |
| Country code - invoice | Country code in the invoice address |
| Company - shipping | Company name in the shipping address |
| For the attention of - shipping | Shipping first name shipping last name in the shipping address |
| Address - shipping | Shipping address house number in the shipping address |
| Postcode - shipping | Postcode in the shipping address, max length 10 |
| City - shipping | City in the shipping address |
| Country code - shipping | Country code in shipping address |
| Payment condition | Payment term |
| Payment method |
|
| lines |
|
| Separate lines are created for the various components of the order. For an order with five individual products and shipping costs, there will be (5 + 1 =) six lines in the Asperion invoice. If the order has five individual products and two surcharges, the Asperion invoice will have (5 + 2 =) seven lines. | |
| Name field | Value |
| Entry type | Is calculated as follows:
|
| SKU | If the product is in Asperion, the SKU of the product is used. Thus, it is only added for entry type A. |
| Description | name or description from the line |
| Amount | quantity |
| Unit price | The unit price is determined as follows
|
| VAT-code | Based on the VAT and ledger settings in the dashboard |
| Revenue account | Based on the VAT and ledger settings in the dashboard. Only added if the booking type is G. |
| This concerns discounts on the entire order that have been allocated proportionally to the VAT percentages on the lines. | |
| Name field | Value |
| Entry type | G, this is a discount line |
| SKU | If the product is in Asperion, the SKU of the product is used. Only added for booking type A. |
| Description | name or description from the line |
| Amount | Quantity |
| Unit price | The unit price is determined as follows
|
| VAT-code | Based on the VAT and ledger settings in the dashboard |
| Revenue account | Based on the VAT and ledger settings in the dashboard. Only added if the booking type is G. |
| Below is a specification at field level for the creation of a payment. | ||
| Name field | Value | Remark |
| Date | 2023-08-01 | Current date |
| Journal | 40 | Memo journal |
| Description | Payment identifier - invoice number | Number of the Asperion invoice |
| Transaction lines | ||
| Payment information line |
|
The VAT amount is 0 |
| Line Asperion invoice |
|
|
| Name field | Values from Shopify order | |
| Name | firstname lastname, max length 50 | |
| Phone number | phone no, max length 15 | |
| City | city | |
| Address | address housenumber | |
| Zip code | zipcode, max length 10 | |
| Country code | isocountry | |
| VAT number | VAT number | |
| Emailaddress | ||
| Payment condition | paymentcondition |
| Name field | Values from Shopify order |
| SKU | articlekey following the logic SKU, EAN, article code |
| Description | description, max length 100 |
| Keep track of article stock | true, cannot be adjusted |
| Fixed selling price | 0, cannot be adjusted |
| General ledger account | revenue account |
| Date added | Current date Y-m-d |
| Date modified | Current date Y-m-d |
| Name | Example | Note |
| Date | Closing date | |
| Debtor number | [customer-id] | Default debtor |
| Description | Closing name | Description |
| Reference | Closing name | |
| Payment condition | payment condition | As configured on the dashboard. |
| Invoice and delivery address | default | |
| Lines |
|
7.Support
Read more Support .... Read less Support ....
Explanation tabs dashboard
On the Dashboard >> Report you can see which orders from your Shopify webshop, and when, have been transferred to Asperion.What if orders are missing in Asperion
If orders are missing in Asperion 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 Asperion (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.