REresolvepay
External Sync

Get accounting synchronization settings

Returns the active accounting platform and its synchronization state.

Use this endpoint to check whether a platform is connected, whether a synchronization is currently running, and why the most recent synchronization failed.

get/external-syncs/settings

Request

Response

The connected accounting platform and its synchronization state.

platform'quickbooks_online' | 'netsuite' | 'null' nullable required

The connected accounting platform, or null when no platform is connected.

status'disconnected' | 'idle' | 'syncing' | 'failed' required

The current synchronization state:

  • disconnected - no accounting platform is connected.
  • idle - a platform is connected and no synchronization is running.
  • syncing - a synchronization is currently in progress.
  • failed - the most recent synchronization failed. See error for details.
last_sync_started_atstring date-time nullable required

When the most recent synchronization started, or null if none has run.

last_sync_completed_atstring date-time nullable required

When the most recent synchronization finished, or null if none has completed.

progressnumber nullable required

Percentage of the in-progress synchronization that has completed. Only reported for QuickBooks Online; null for other platforms.

Example response

{
  "platform": "quickbooks_online",
  "status": "idle",
  "last_sync_started_at": "2021-05-20T09:23:53+00:00",
  "last_sync_completed_at": "2021-05-20T09:31:07+00:00",
  "progress": 42,
  "error": {
    "message": "The QuickBooks Online connection has expired. Reconnect the integration to resume syncing."
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.