Sync Configuration

Sync Configuration Overview

Sync configuration allows you to customize how Rutter syncs data from your connected platforms. You can control which entities are synced, how far back in time to fetch historical data, and how frequently to perform incremental syncs.

Platform Support

Sync configuration is currently supported for:

• QuickBooks (QUICKBOOKS)
• Xero (XERO)
• NetSuite (NETSUITE)
• Zoho Books (ZOHOBOOKS)
• Sage Business Cloud (SAGE_BUSINESS_CLOUD)
• FreshBooks (FRESHBOOKS)
• QuickBooks Desktop (QUICKBOOKS_DESKTOP)
• Dynamics 365 (DYNAMICS365)
• Moneybird (MONEYBIRD)
• Odoo (ODOO)
• Stripe (STRIPE)

Additional platform support will be added in future releases.

Configuration Levels

Sync configuration can be managed at three levels:

1. Organization Level - Organization-wide defaults for all platforms, grouped by platform type (e.g. accounting, commerce, etc.). This is configurable in the Rutter Dashboard under the "Data Sync Configuration" page.
2. Platform Level - Organization-wide defaults for a specific platform (e.g., all QuickBooks connections)
3. Connection Level - Per-connection overrides

1
{
2
  "initialSync": {
3
    "batches": [
4
      {
5
        "timeFrameInMonths": 12,
6
        "entities": [
7
          "ACCOUNTING_TRANSACTION"
8
        ]
9
      }
10
    ]
11
  },
12
  "incrementalSync": {
13
    "syncPeriodInMinutes": 120,
14
    "entities": [
15
      "ACCOUNTING_TRANSACTION"
16
    ]
17
  }
18
}

1
{
2
  "initialSync": {
3
    "batches": [
4
      {
5
        "timeFrameInMonths": 12,
6
        "entities": [
7
          "ACCOUNTING_TRANSACTION"
8
        ]
9
      }
10
    ]
11
  },
12
  "incrementalSync": {
13
    "syncPeriodInMinutes": 120,
14
    "entities": [
15
      "ACCOUNTING_TRANSACTION"
16
    ]
17
  }
18
}

1
{
2
  "initialSync": {
3
    "batches": [
4
      {
5
        "timeFrameInMonths": 12,
6
        "entities": [
7
          "ACCOUNTING_TRANSACTION"
8
        ]
9
      }
10
    ]
11
  },
12
  "incrementalSync": {
13
    "syncPeriodInMinutes": 120,
14
    "entities": [
15
      "ACCOUNTING_TRANSACTION"
16
    ]
17
  }
18
}

1
{
2
  "initialSync": {
3
    "batches": [
4
      {
5
        "timeFrameInMonths": 12,
6
        "entities": [
7
          "ACCOUNTING_TRANSACTION"
8
        ]
9
      }
10
    ]
11
  },
12
  "incrementalSync": {
13
    "syncPeriodInMinutes": 120,
14
    "entities": [
15
      "ACCOUNTING_TRANSACTION"
16
    ]
17
  }
18
}