External Sync

Synchronize accounting data

Queues an on-demand accounting data synchronization for the merchant.

Synchronization runs in the background: a 200 response means the sync was queued, not that it has finished. Poll Get accounting synchronization settings to follow its progress.

Rate limits are applied per accounting platform:

Incremental syncs (full_sync: false, the default) - one request every five minutes.
Full syncs (full_sync: true) - one request every hour.

Exceeding either limit returns 429 with a Retry-After header.

post/external-syncs/{platform}/sync

Request

Base URL
https://app-sandbox.resolvepay.com/api
Auth
- HTTP bearer
- or HTTP basic
TypeScript
https://skmtc.dev/resolvepay/apis/resolve-api-reference/docs/external-syncs/:platform/sync/post.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

platform'quickbooks_online' | 'netsuite' required

The connected accounting platform to synchronize.

Request body

full_syncboolean

Fetch all accounting data instead of only the changes since the last synchronization. Full syncs are rate limited more aggressively than incremental syncs.

Response

The request was accepted.

successtrue required

Always true when the request was accepted.

Example response

{
  "success": true
}

Changes

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