Skip to main content

Getting Started with Magento FreeAgent Integration

Welcome to Magento FreeAgent Integration - the enterprise-grade connector that seamlessly integrates your Magento 2 e-commerce platform with FreeAgent accounting software.

What is Magento FreeAgent Integration?​

Magento FreeAgent Integration is a powerful, bi-directional integration solution that automates critical accounting and financial processes between Magento 2 and FreeAgent. It eliminates manual data entry, reduces errors, and ensures financial data consistency across both platforms.

Key Features​

  • Invoice Synchronization - Automatically export Magento orders as FreeAgent invoices
  • Contact Management - Keep customer data synchronized across both systems
  • Credit Memo Processing - Export credit memos to FreeAgent as credit notes
  • Profile-Based Sync - Flexible, configurable synchronization profiles
  • OAuth Authentication - Secure OAuth 2.0 connection with automatic token refresh
  • Enterprise Ready - Queue processing, retry logic, logging, and notifications

What You'll Need​

Before you begin, make sure you have:

  1. Magento FreeAgent Integration License - Contact Byte8 Ltd for licensing
  2. Magento 2.4.x - Compatible Magento installation
  3. PHP 8.1+ - PHP 8.1 or higher
  4. FreeAgent Account - Active FreeAgent account with API access
  5. Composer - For installing the extension

Quick Start​

Follow these steps to get Magento FreeAgent Integration up and running.

Step 1: Check System Requirements​

Verify your system meets all requirements:

  • Magento 2.4.4 or higher
  • PHP 8.1 or higher (8.2, 8.3, 8.4, 8.5 supported)
  • MySQL 8.0 or MariaDB 10.6
  • Required PHP extensions (curl, json, openssl, xml, zip, mbstring)

Step 2: Install Magento FreeAgent Integration Connector​

Setup Composer Repository​

After purchasing the extension, you'll receive access to a private Composer repository:

# Add the private repository
composer config repositories.private-packagist composer https://byte8.repo.packagist.com/your-repository-name/

# Setup authentication (use token as username)
composer config --global --auth http-basic.byte8.repo.packagist.com token your-access-token

Install the Package​

composer require byte8/magento-freeagent-suite

Complete Installation​

bin/magento setup:upgrade
bin/magento setup:di:compile
bin/magento setup:static-content:deploy
bin/magento cache:flush

For detailed installation instructions, see the Composer Installation Guide.

Step 3: Configure FreeAgent Connection​

Configure your FreeAgent API connection in the Magento Admin panel:

  1. Navigate to Stores > Configuration > Byte8 > FreeAgent Integration
  2. Select the client mode (Production or Sandbox)
  3. Enter your Client ID and Client Secret from FreeAgent
  4. Click Authorize to complete the OAuth flow
  5. Test the connection

For detailed configuration instructions, see the Client Configuration Guide.

Step 4: Configure Profile Settings​

Set up profile execution settings and notification system:

  1. Navigate to Stores > Configuration > Byte8 > Profile Configuration
  2. Configure profile history retention period
  3. Enable notifications if desired
  4. Set up email alerts for critical errors

For detailed instructions, see the Profile Configuration Guide.

Step 5: Create and Configure Profiles​

Set up synchronization profiles for each entity type:

  1. Navigate to Byte8 > FreeAgent > Profiles in the admin panel
  2. Create profiles for contacts, invoices, and credit memos
  3. Configure each profile's schedule, batch size, and processing options
  4. Enable the schedule for automated sync

Verification Steps​

After completing the setup, verify everything is working:

# Flush cache
bin/magento cache:flush

# Test with a manual sync
bin/magento fa_contact:export --dry-run

What's Next?​

Now that setup is complete, configure your integration profiles:

Need Help?​

Architecture Overview​

graph LR
    A[Magento 2] <-->|Magento FreeAgent Integration| B[FreeAgent]
    A -->|Invoices| B
    A -->|Contacts| B
    A -->|Credit Memos| B
    B -->|Status Updates| A

Understanding this bi-directional architecture helps you configure the integration effectively.