CLI Commands for e-Boekhouden Integration
Command line tools for e-Boekhouden integration. These commands are useful for manual syncing, troubleshooting, and automation scripts. All commands are provided by the accounting-base module.
Available Commands
| Command | Description |
|---|---|
accounting:selftest |
Run diagnostic tests |
accounting:sync:orders |
Sync invoices to e-Boekhouden |
accounting:selftest
Run diagnostic tests to verify module configuration and connectivity.
bin/magento accounting:selftest
What it checks:
- Module enabled status
- e-Boekhouden API connection
- Ledger configuration
- Tax rate mapping
- Cron status
When to use:
- After initial setup to verify configuration
- When sync stops working unexpectedly
- Before contacting support (include output in ticket)
Example output:
Module Enabled: success
- Module is enabled
Connection: success
- Connected to e-Boekhouden account: [Your Account]
Ledger Configuration: success
- Product ledgers configured
Tax Rate Mapping: warning
- 2 tax rules not mapped
accounting:sync:orders
Manually sync invoices to e-Boekhouden. Useful for re-syncing failed invoices or processing historical data.
Sync Single Order
bin/magento accounting:sync:orders --order-id=100000123
Syncs all invoices for the specified order ID (the increment_id from the sales order grid).
Sync Date Range
bin/magento accounting:sync:orders --from-date=2024-01-01 --to-date=2024-01-31
Syncs all invoices created between the specified dates. Dates can include time:
bin/magento accounting:sync:orders --from-date="2024-01-01 00:00:00" --to-date="2024-01-31 23:59:59"
Sync Recent Orders
bin/magento accounting:sync:orders --offset=7
Syncs all invoices from the last 7 days. Useful for catching up after downtime.
Options Reference
| Option | Description | Example |
|---|---|---|
--order-id |
Magento order increment ID | --order-id=100000123 |
--from-date |
Start date (inclusive) | --from-date=2024-01-01 |
--to-date |
End date (inclusive) | --to-date=2024-01-31 |
--offset |
Days back from today | --offset=7 |
Notes:
--from-daterequires--to-date(or defaults to today)- Options are mutually exclusive: use either
--order-id, date range, or--offset - Only processes invoices that exist in the accounting queue
Common Use Cases
Re-sync Failed Invoice
When an invoice failed to sync (visible in Synchronisation Logs):
bin/magento accounting:sync:orders --order-id=100000456
Catch Up After Downtime
If cron wasn't running for a few days:
bin/magento accounting:sync:orders --offset=5
Initial Historical Sync
To sync invoices from a specific period:
bin/magento accounting:sync:orders --from-date=2024-01-01 --to-date=2024-03-31
Debug Specific Order
Combined with debug mode enabled in configuration:
- Enable debug mode in admin
- Run:
bin/magento accounting:sync:orders --order-id=100000789 - Check
var/log/eboekhouden/debug.logfor detailed output
Need More Help?
Documentation:
- All Help Articles - Complete documentation overview
Support:
- Contact Support - Get help from our team