Understand connection capabilities and permissions
This reference explains which connector cards are supported in Settings > Integrations, what credentials each one needs, and what happens when you save credentials, connect Plaid, or request a sync or backfill. It also notes the role and workspace permissions needed for those actions and what to do when a request is skipped, disabled, or rejected.
Before you start
- You must be signed in to the workspace that owns the connector you want to review.
- For management actions, you need the owner/admin role in that workspace.
- Some actions also require the Integrations management entitlement, and some connector cards require a connector-specific entitlement before they can be used.
- For Plaid connection actions, the browser must finish loading Plaid Link before you can connect or reconnect a bank.
- For manual sync or backfill actions, the workspace must allow manual syncs; if it does not, the button stays disabled. For sync-related actions, the page may show that nightly sync will run automatically. This message does not apply to the backfill-only branch.
What this reference covers
This article explains the connector scopes shown in the Integrations area, the credentials each connector expects, and the difference between configured, available, and not present. It also explains the visible effects of saving credentials, connecting banks, starting syncs, and requesting backfills.
Supported connector scopes
| Connector | Visible actions | Credential fields shown | Notes |
|---|---|---|---|
| Plaid | Connect Bank (Plaid), Reconnect, Trigger Sync | No credential fields on the card | The bank connection flow uses Plaid Link and the card can be available even when no connector is pre-seeded. |
| Mercury | Manage Mercury Connectors, Refresh accounts, Save account selection, Add Connector | Mercury API key | The card supports multiple Mercury connector instances and account selection. |
| Wise | Save Credentials, Trigger Sync, Trigger Backfill | Wise API token; Wise API base (optional) | The base URL is optional and is stored only when provided. |
| PayPal | Save Credentials, Trigger Sync, Trigger Backfill | PayPal client_id; PayPal client_secret; PayPal base_url (optional) | The base URL is optional and must be entered as a secure URL if used. |
| ERPNext | Save Credentials, Trigger Sync, Trigger Backfill | ERPNext base_url; ERPNext api_key; ERPNext api_secret; ERPNext company | This connector is the ledger destination used by the import workflow. |
| Shopify | Save Credentials, Trigger Sync, Trigger Backfill | Shopify shop_domain; Shopify access_token | The domain and token are saved together. |
| Flexport | Save Credentials, Trigger Sync, Trigger Backfill | Flexport api_token; Flexport api_base (optional) | The base URL is optional and must be secure if used. |
What configured means
A connector is marked configured only when the required secrets for that connector are present, and, for ERPNext, when the company field is also present. If a required secret or config value is missing, the card can still appear, but it remains unconfigured.
How to add or update connector credentials
- Open Settings, then open Integrations.Integrations
- Find the connector card you want to configure.
- Enter the visible fields for that connector. Secret values are masked in the form, but they are saved when you click Save Credentials or the connector-specific save button.Save Credentials
- Click Save Credentials, or for Mercury use Save Selected Connector Key after choosing the target connector in the modal.Save CredentialsSave Selected Connector Key
- Wait for the success message and refresh. For Mercury, the account list reloads after a successful save.
If the save succeeds, the inputs are cleared in the form and the page reloads its saved connector state. If the save fails, the error stays on screen and the values are not cleared.
Plaid connection, reconnection, and sync
- On the Plaid card, click Connect Bank (Plaid) to start a new connection.Connect Bank (Plaid)
- If you are reconnecting an existing bank connection, click Reconnect instead.Reconnect
- After a successful new connection, the page exchanges the returned connection token and shows how many accounts were connected.
- To request a manual Plaid sync, click Trigger Sync if manual sync is enabled in your workspace.Trigger Sync
The Connect Bank and Reconnect buttons are only useful after the browser has loaded the Plaid Link SDK. Until then, the card shows that Plaid Link is still loading. If the SDK never loads, the Plaid buttons stay unavailable.
Mercury connector management
- On the Mercury card, click Manage Mercury Connectors.Manage Mercury Connectors
- In the modal, choose the connector instance you want to work with.
- Enter or update the Mercury API key for that selected connector, then save it.Mercury API key
- Refresh accounts to load the accounts that are accessible with that key.Refresh accounts
- Select the accounts your workspace should use and save the selection.
- If needed, click Add Connector to create another Mercury connector instance.Add Connector
Mercury selection is per connector instance. Saving the selected accounts updates which Mercury accounts will be used for later syncing, and the page message confirms how many accounts were connected.
Manual sync and backfill behavior
Manual sync and backfill are separate actions. Manual sync requests a sync run for the active connector, while backfill requests a historical window using the visible since and until fields. Both actions rely on the workspace allowing manual syncs.
- The Sync from date field sets the starting date used by manual sync and Plaid sync requests on the page.
- The until field is used with backfill requests, and it is submitted exactly as entered.
- If manual sync is disabled, the button shows a message instead of sending a request.
- If a backfill or sync request fails, the error is shown and you can retry after fixing the input or entitlement issue.
Feature and role dependencies
- Owner/admin role is required for connector credential changes and several bank actions.
- Integrations management entitlement is required for the Integrations page actions that manage connectors.
- Connector-specific entitlements control whether a given connector card can be used.
- Some import and accounting workflows also require ERPNext-related entitlement and a connected destination company.
What happens after you save or submit
| Action | What you should expect | What is not changed immediately |
|---|---|---|
| Save connector credentials | The page clears the form, shows a saved message, and refreshes connector status. | No books are posted just by saving credentials. |
| Connect a Plaid bank | The page confirms the connection and begins the bank-account flow. | A bank connection does not itself create ledger entries. |
| Trigger sync | A sync run is queued and the page shows the returned sync run reference. | The sync is asynchronous; the final transaction outcome is not confirmed immediately. |
| Trigger backfill | A backfill run is queued for the selected date range. | The data is not posted right away on the click itself. |
| Save Mercury account selection | The page confirms the number of connected accounts and reloads state. | No immediate ledger posting is shown in the page. |
| Fresh balance refresh | The page shows refreshed account balance data or a skipped result. | The refresh may be skipped if the daily window already used the refresh or if paid fresh balance is disabled. |
Common failure recovery
- If a credential save fails, correct the field and click the same save button again.
- If Plaid says it is still loading, wait for the browser to finish loading the Plaid SDK before retrying.
- If manual sync is disabled, ask an owner/admin to enable it in the workspace settings if that is permitted for your workspace.
- If a sync or backfill request fails, fix the visible date range or credential issue and retry with a new save or request.
- If a Mercury account is missing from the list, refresh accounts after saving the correct Mercury key.
Related workflows
- Connect ERPNext
- Manage integrations
- Connect Mercury
Updated