Configuration Guide for Yuki Connection
Here's where you'll find all the settings for the Yuki Connection. This guide explains what each option does and when you'd want to use it. Settings are split across two locations in the Magento admin: the shared accounting base (General) and the Yuki-specific settings. We've organized the sections in the same order as they appear in your admin panel, so you can jump straight to what you need. Some options — like ledger accounts and tax code fallbacks — require you to import data from Yuki first before they become useful. We've called those out where relevant.
General Settings
Navigate to: Stores → Configuration → Accounting → General
These settings apply to the shared accounting layer and affect all accounting integrations, not just Yuki.
Enabled
Turns the accounting module on or off. When disabled, no invoices or credit memos will be queued or synced, regardless of any other settings.
Start Date
Only invoices and credit memos created on or after this date will be synced to Yuki. Anything before this date is ignored.
When to use:
- You're going live mid-month and don't want to import historical orders
- You're migrating from another accounting integration and want a clean cutoff
Auto Add Invoices and Credit Memos
When enabled, every new Magento invoice or credit memo is automatically added to the sync queue as soon as it's created. When disabled, you have to push them manually from the admin grids.
When to use:
- Enable this in most setups — it's the main automation you want
- Disable if you need to review invoices before they're sent to Yuki
Auto Add Customers
When enabled, new customers are automatically synced to Yuki when an invoice is processed. This keeps your Yuki customer list up to date without manual intervention.
Prefix Credit Memo
Adds a prefix to the credit memo number when it's sent to Yuki. Useful when you need to distinguish credit memos from invoices in Yuki's document list.
Credit Memo Prefix
The actual prefix string to prepend to credit memo numbers (for example: C). Only applies when Prefix Credit Memo is enabled. The result would look like C1000001.
Prefix Invoice
Same concept as the credit memo prefix, but for invoices.
Invoice Prefix
The prefix string to use for invoices when Prefix Invoice is enabled.
Customer Sync Logic
Controls which address data is used when syncing a customer record to Yuki.
| Option | What it uses |
|---|---|
| Default | Magento's default customer billing address |
| Customer | The customer's stored account address |
| Address | The order billing address at time of invoice |
When to use:
- Use Address if your customers frequently order with different billing details per order
- Use Customer if you want a consistent address tied to the customer account
Force Base Currency Usage
When enabled, all amounts are sent to Yuki in the store's base currency, regardless of the currency the customer used at checkout.
When to use:
- Enable this if your Yuki administration is set up in a single currency (usually EUR) and you don't want multi-currency amounts flowing in
- Leave disabled if you operate in multiple currencies and want Yuki to handle conversion
Yuki Settings
Navigate to: Stores → Configuration → Accounting → Yuki
Enabled
Turns the Yuki integration on or off. This controls whether Yuki-specific processing (API communication, ledger mapping, etc.) is active.
Synchronization
Sets how often the cron job runs to push queued invoices and credit memos to Yuki.
| Option | When to use |
|---|---|
| Every 5 minutes | High-volume stores, near real-time requirements |
| Every 15 minutes | Most stores — good balance of speed and load |
| Every 30 minutes | Lower volume stores |
| Every 60 minutes | Very low volume or if you want less API calls |
| Daily | Manual-style setups where near real-time isn't needed |
This field only appears when Enabled is set to Yes.
Connection
This section configures the actual API connection to your Yuki administration.
Enabled
Enables the connection for the current scope (default, website, or store view). You can have the integration active for some websites and not others.
API Key
Your Yuki API key, stored encrypted. You'll find this in your Yuki account under Settings → API.
Tip: After entering your API key, always click Check Credentials to verify it works before saving.
Administration
Once your credentials are verified, this dropdown lists the Yuki administrations available under your API key. Select the administration you want invoices synced into.
This field is only populated after a successful credentials check and is only available at the default scope — not per website or store view.
Check Credentials
A button that validates your API key and loads the list of available administrations into the Administration dropdown. Run this after entering or updating your API key.
Import Info
Imports ledger accounts and tax codes from your Yuki administration into Magento. This populates the dropdowns in the Ledger Accounts section and the Tax Rate Mapping grid.
Tip: Run this before configuring ledger accounts. Without it, all ledger dropdowns will be empty.
Ledger Accounts
These settings define which Yuki ledger account is used for each type of line item on an invoice. All dropdowns are populated from the ledger accounts you imported via Import Info.
Tip: If the dropdowns are empty, go back to the Connection section and click Import Info first.
Product
The default ledger for product line items. This applies to all products unless overridden at the product level in the catalog.
Recommended: 80000 or your primary revenue ledger.
Shipping
The ledger for shipping cost line items on invoices.
Adjustment Fee
The ledger for order adjustment amounts (positive or negative adjustments applied to an order total).
Payment / Extra Fee
The ledger for payment surcharges — for example, fees added by a payment method.
Advanced Settings
Invoice Settings
Invoice Type
Controls whether invoices are created in Yuki as definitief (processed/final) or concept (draft).
| Option | When to use |
|---|---|
| definitief | Most setups — invoices are final and processed immediately |
| concept | When you want to review invoices in Yuki before finalizing |
Recommended: definitief for fully automated setups.
Payment Method
The payment method label to attach to invoices in Yuki. Defaults to Online.
Payment Days
The number of days from the invoice date that payment is due. This sets the due date on the invoice in Yuki.
Recommended: 14 days is the default and works for most setups. Adjust to match your actual payment terms.
Descriptions
Invoice Description
The description line added to each invoice in Yuki. Supports the following placeholders:
| Placeholder | Replaced with |
|---|---|
{invoice_number} |
The Magento invoice number |
{order_number} |
The Magento order number |
{transaction} |
The transaction/payment reference |
{transaction_clean} |
Transaction reference with special characters stripped |
Default: Invoice #{invoice_number} for order #{order_number}
Credit Memo Description
Same as invoice description, but for credit memos. Uses the same placeholders plus:
| Placeholder | Replaced with |
|---|---|
{creditmemo_number} |
The Magento credit memo number |
Default: Creditmemo #{creditmemo_number} for order #{order_number}
One Stop Shop (OSS)
Enable OSS
Enables automatic VAT type 40 handling for B2C orders shipped to EU countries. This is required if your store falls under the EU One Stop Shop VAT scheme.
When to use:
- Your store sells to B2C customers in EU countries outside the Netherlands
- You're registered for OSS and need to report VAT per destination country
Important: For each EU country you enable, you must also create a matching BTW tax code with type 40 in Yuki (one per country).
OSS Countries
A multiselect of EU countries (Netherlands excluded) for which OSS VAT handling is applied. Only visible when Enable OSS is set to Yes.
Select all countries where you sell B2C and want Yuki to apply the destination country VAT rate via type 40.
Advanced Ledger Mapping
Enable Advanced Ledger Mapping
When enabled, you can map specific product attribute values to specific Yuki ledger accounts. This is useful when different product types should go to different revenue ledgers in Yuki.
Mapping
A dynamic table where you define the mapping rules. Each row maps a product attribute value (e.g., a product type or category) to a specific ledger account.
Only visible when Enable Advanced Ledger Mapping is set to Yes.
Default Tax Classes (Fallback)
These fallback tax codes are used when Magento's tax rate cannot be matched in the Tax Rate Mapping grid. This can happen after data migrations, imports, or when a new tax rule hasn't been mapped yet.
Tip: These are safety nets, not the primary mapping. Set up your Tax Rate Mapping grid properly — these only kick in when nothing else matches.
With Tax
Fallback Yuki tax code for taxed line items (e.g., standard Dutch VAT).
Default: Hoog
No Tax
Fallback for domestic (NL) line items with no tax — for example, exempt goods.
Default: Exempt
EU No Tax
Fallback for intra-EU B2B sales (ICP/ICL) where no VAT is charged.
Default: ExportBinnenEU
No EU No Tax
Fallback for sales outside the EU with no VAT applied.
Default: ExportBuitenEU
Debug & Logging
Debug Mode
When enabled, all API requests and responses between Magento and Yuki are written to a log file. Error logging is always active regardless of this setting.
Log files:
var/log/yuki-debug.log— API request/response details (only when debug mode is on)var/log/yuki-error.log— Errors and warnings (always logged)
When to use:
- Enable temporarily when troubleshooting sync issues
- Disable in production once everything is working — the logs can get large on busy stores
Self Test
A diagnostic button that runs a series of checks on the module configuration and connection. Use this to quickly verify that everything is set up correctly after initial configuration or after making changes.
Configuration Checklist
- Enable the accounting module in General Settings
- Set a Start Date to control how far back invoices sync
- Enable Auto Add Invoices and Credit Memos for hands-free sync
- Enable Auto Add Customers if you want customer records synced to Yuki
- Enable the Yuki integration and set your preferred sync frequency
- Enter your API key and click Check Credentials
- Select your Administration from the dropdown
- Click Import Info to import ledgers and tax codes from Yuki
- Assign ledger accounts for Product, Shipping, Adjustment Fee, and Payment/Extra Fee
- Set up Tax Rate Mapping to match Magento tax rules to Yuki tax codes
- Set fallback Default Tax Classes as a safety net
- Configure Invoice Description and Credit Memo Description to your preference
- Enable OSS and select OSS Countries if applicable (and create matching type 40 codes in Yuki)
- Set up Advanced Ledger Mapping if you need per-product-attribute ledger routing
- Run Self Test to verify the setup
- Disable Debug Mode in production once everything is confirmed working
Need More Help?
Documentation:
- All Help Articles - Complete documentation overview
Support:
- Contact Support - Get help from our team