1.Introduction
This is the manual for the integration between Woocommerce and Asperion.
- This integration is a financial integration. It is not a logistics integration. It is not suitable for updating customers in Asperion, 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 do our utmost to keep the manuals up to date. No rights can be derived from the content of this manual. We appreciate customer feedback to further improve the manuals.
- Tip: Other customers using this integration found the tips in the FAQ for Woocommerce and in the FAQ for Asperion.
Installing the integration starts with signing up for a trial period, via our integrations page. After registering, you'll receive an email containing an installation URL and login details. Use this installation URL to start the integration setup. Installation is complete when both dots for the connection are green and the settings in the Configuration tab have been entered and saved.
There is a 30-day trial period. 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.
When uninstalling the integration, we recommend revoking the consumerkey and consumersecret in WooCommerce.
2.How the integration works
New orders from your online store are retrieved at least once per hour. If webhooks are enabled in the Woocommerce webshop, orders are retrieved in real time. In addition, any previously retrieved orders that have not yet been sent to your accounting system are checked every night. For more details see the FAQ.
Read more How the integration works .... Read less How the integration works ....
At the start of processing a order we perform a number of checks on the Woocommerce order:
- It is checked whether the total of the Woocommerce order is equal to the sum of the amounts in the order lines plus the shipping 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 processed for every order that has been processed to Asperion and that has been paid in Woocommerce. It is possible to always process the payment, regardless of the status in Woocommerce. This can be requested via webcare@webwinkelfacturen.nl.
Processing a Woocommerce 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 Woocommerce 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 Woocommerce 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 completed. The Woocommerce order appears in the Report 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: WooCommerce keys
The last paragraph of this chapter "WooCommerce Keys" is only necessary if you want to push real-time orders in addition to the regular batch. If you skip this subsection, your orders from WooCommerce will still be transferred regularly and automatically at the batch level after installing the connection in the next chapter.
To create the webhook, click on the "Webhooks" tab within the "Advanced" main tab and then on the "Add webhook" button.
In the screen that has now opened, fill in the requested information. Provide a clear description for the name of the webhook. The Status must be "active". In the third field, enter when the webhook is activated. We recommend choosing "Order updated" (Dutch "Order gewijzigd") here.
At “Delivery URL" enter: https://interface.cloudinvoice.company/api/v1/servlet/woocommerce/webhook.php?licensekey=UWLICENTIESLEUTEL
where "UWLICENTIESLEUTEL" is of course your own specific webwinkelfacturen.nl license key that you received in your email confirmation of the connection (a 32-character letter/number combination). For the secret, enter the WooCommerce consumer secret as generated at the beginning of this paragraph. Finally, you must save the configuration (save webhook).
Indien je later ooit de Webhooks zou willen de-activeren, ga je binnen "Advanced” tab naar subtab "Webhooks" en kiest voor die specifieke webhook "delete permanently”.
4.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.
5.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 WooCommerce webshop. In this step you authorize the integration to read data from your webshop.
2. Establishing the connection with Asperion. This authorizes the integration to write transactions to your Asperion administration and read information.
3. The configuration itself.
The connection with the Woocommerce webshop is established using the Clientkey and Clientsecret that you created in a previous section. Click the red Connect button next to Woocommerce and enter the Clientkey and Clientsecret in the popup window. If the connection is established correctly the indicator will turn green. If the connection is not established then this is the FAQ for troubleshooting.
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 Woocommerce you can work with standard VAT rates or with the VAT rates from the webshop. We recommend that you work with standard VAT rates. This takes a little more time to set up, but it prevents orders from not being processed to Asperion.
Option 1:
With standard VAT rates you work with a list of VAT rates per EU country. You can adjust the VAT percentage for orders and configure the VAT settings for Asperion per EU country. For example, if you deliver to Germany you can indicate in the settings that 19% and/or 7% VAT is used and that it should be booked to a separate code in Asperion.
Option 2:
With VAT rates from the shop the integration retrieves the VAT rates from the webshop. Countries that are not present in the webshop VAT settings will therefore not appear in the list. Woocommerce works with VAT percentages and VAT classes. This combination is loaded and validated by the integration. An order with 21% VAT and VAT class reduced will often not be processed because in Woocommerce the VAT class standard usually belongs to 21%.
We often see this go wrong, which is why we recommend the first option, namely standard VAT rates. 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.
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.
6.Day-to-day: From WooCommerce
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.
Payments (if activated):
When processing payments, the integration checks every day the Woocommerce orders that have been successfully forwarded to Asperion. If the order has been forwarded and the status of the order in Woocommerce is paid, then a payment will be created in Asperion for this order. If desired, payments can always be created — regardless of the status of the order in Woocommerce. Send an email to webcare@webwinkelfacturen.nl to request this.
Orders that are picked up and have a status other than one of the selected options will automatically be transferred the following night if they have one of the selected options in WooCommerce.
* Technical: This concerns the fields [total], [total_tax], [subtotal], [subtotal_tax] and [taxes] per order line in [line_items].
- The fields [total] and [total_tax] contain the line amount excluding VAT and the VAT amount after discount, in two decimals
- The fields [subtotal] and [subtotal_tax] contain the line amount excluding VAT and the VAT amount before discount, in two decimals.
- The [taxes] field contains the same amounts but with four decimals. The integration uses the values in [taxes] for the VAT calculation.
Please note: The integration looks back 30 days to retrieve refunds. Refunds that come in later cannot be processed by the integration. The integration only processes a refund if it has previously processed the order to which the refund relates. Finally, the integration only processes full refunds . Partial refunds are not processed. For more information see the FAQ
Pay special attention to fields that come from plugins. There is a good chance that the integration does not process these fields. For example, with discount plugins the amounts may not be correctly included in the order, preventing the order from being processed.
Field-level specification orders
| Name field | Values from Woocommerce order |
| Order-identifier | [id] |
| Order number | A fixed prefix followed by field [number]. The prefix configuration can be requested via webcare@webwinkelfacturen.nl |
| Invoice number | Determined from the [meta_data]. The following fields are examined in turn. The first one present is returned.
|
| Booking date | [date_created] |
| Order date | [date_created] |
| Status order | [status] |
| Payment status | If the status of the order is completed or processed or if [date_paid] has been entered then paid |
| Payment reference | [id] |
| Note | [customer_note] |
| Is it a Bol.com order? | The answer is yes if there is a field [customer_user_agent] with the value effectconnect and the field [billing][email] is a bol.com email address |
| Is it a Fonq order? | The answer is yes if it is not a Bol.com order and there is a field [customer_user_agent] with the value effectconnect |
| Is it another order coming through an external party? | The answer is yes if the key is part of a fixed set of keys. This list can be expanded upon request. |
| Affiliate number |
The affiliate number is determined as follows:
|
| Valuta | If the currency option is set for the customer then [currency] |
| 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 |
| Delivery country | The delivery country will be the [shipping][country] field if it is filled in. Otherwise, the [billing][country] field will be used. |
| 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:
|
| Do the order lines have VAT? | To determine whether VAT is applied to order lines, the [subtotal_tax] and [total_tax] fields are examined per line, and the [shipping_tax] fields are examined in the order itself. If any of these fields have a value other than 0, VAT is applied to the order lines. If all fields have a value of 0, there is no VAT on the order lines. |
| 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 Woocommerce order line | |
| Productid | [product_id] | |
| Category | In the case of processing categories, the category ID and name | |
| Amount | [quantity]. Note: if the quantity is 0, parsing stops. | |
| SKU | If the SKU is filled, then [sku]. Otherwise [product_id]. | |
| Description | [name] plus the values ​​in field [meta] in the order line with key / key label or key | |
| VAT percentage |
The VAT percentage is determined as follows:
|
|
| Amounts excl. VAT | Amount in field [total] | |
| Amounts incl. VAT | Amount in field [total] plus the amount in field [total_tax] | |
| Discount in order line | An order line has two totals: [total] and [subtotal]. The [total] amount is the line amount including the discount, and the [subtotal] amount is the amount excluding the discount. Discounts are therefore processed directly in the order line and not added as separate lines. | |
| 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 the order is an ICP or international order. If processing is done based on categories, the revenue account is determined using the revenue account configured for the respective category in 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 Woocommerce order line | |
| Description | [method_title] from the last shipping cost line | |
| VAT amount shipping costs | Each line in the [shipping_lines] field can contain multiple VAT lines in the [taxes] field. These are summed and the total is the VAT amount for shipping costs. | |
| Shipping costs excl VAT | [shipping_total] in the order | |
| Shipping costs incl VAT | Shipping costs excl. VAT plus the VAT amount for the shipping costs. | |
| VAT percentage | VAT amount for shipping costs divided by the shipping cost amount excl. VAT | |
| 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. | |
| The surcharges are stored in the [fee_lines] field. Each surcharge becomes a separate line in the order. | ||
| Name field | Values from Woocommerce order line | |
| Description | [name] | |
| VAT amount | If it is an international or ICP order then 0, otherwise the amount in the [total_tax] field. | |
| Amount excl VAT | [total] in the order | |
| Amount incl VAT | Amount excl. VAT plus VAT amount | |
| VAT percentage | VAT amount of the surcharge divided by the amount excl. VAT | |
| 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 Woocommerce customer |
| The billing address is in field[billing] and the shipping address in field [shipping]. The content of these fields is always the same, so we do not describe them separately. | |
| Address |
If present based on [billing_address] in the Woocommerce order
|
| VAT number | The VAT number may be present in the [meta_data] of the order. There is a fixed list of keys that are searched. If the VAT number is not found, the integration continues searching in the [vat_number] and VIES data fields in the order. A VAT number is always validated. |
| The option to forward payments to Asperion in addition to orders can be requested via webcare@webwinkelfacturen.nl. This option has additional costs. The payment is created if the field [date_paid] is filled. | |
| Name field | Values from Woocommerce order |
| Order id | The field [id] from the order |
| Payment id | The field [payment_method]]#[transaction_id] from the order |
| The paid amount | The field [total] from the order |
| Payment method | [payment_method_title] |
| Status | [status] |
| Transaction-id | Retrieved from the [meta_date] key, [_mollie_payment_id] key. If this field is not found, the [transaction_id] field from the order is used.|
| Payment date | [date_paid] |
7.Day-to-day: To Asperion
For orders in Woocommerce, 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 Woocommerce, 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 Woocommerce and Asperion can be found in this FAQ read here.
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 Woocommerce 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 Woocommerce 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 Woocommerce 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 |
8.Support
Read more Support .... Read less Support ....
Explanation tabs dashboard
On the Dashboard >> Report you can see which orders from your Woocommerce 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.