Get accounting synchronization settings

Request

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.

Security

bearerAuth or basicAuth

curl -i -X GET \
  https://docs.resolvepay.com/_mock/merchant-api/openapi/external-syncs/settings \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

The connected accounting platform and its synchronization state.

Bodyapplication/json

platformstring or nullrequired

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

Enum:"quickbooks_online""netsuite"null

Example:"quickbooks_online"

statusstringrequired

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.

Enum:"disconnected""idle""syncing""failed"

Example:"idle"

last_sync_started_atstring or null, (date-time)required

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

Example:"2021-05-20T09:23:53+00:00"

last_sync_completed_atstring or null, (date-time)required

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

Example:"2021-05-20T09:31:07+00:00"

progressnumber or null, [ 0 .. 100 ]required

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

Example:42

errorobject or nullrequired

Details of the most recent failure. Only set when status is failed, otherwise null.

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": null,
  "error": null
}