---
title: "Synchronize accounting data"
method: POST
path: "/external-syncs/{platform}/sync"
tags: ["External Sync"]
---

# Synchronize accounting data

`POST /external-syncs/{platform}/sync`

## Request

- Base URL: `https://app-sandbox.resolvepay.com/api`
- URL: `https://app-sandbox.resolvepay.com/api/external-syncs/{platform}/sync`
- Auth: one of:
  - HTTP bearer
  - 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)

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](#operation/getExternalSyncSettings) 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.

## Path parameters

- `platform` 'quickbooks_online' | 'netsuite', required

## Request body

- object
  - `full_sync` boolean: Fetch all accounting data instead of only the changes since the last synchronization. Full syncs are rate limited more aggressively than incremental syncs.

## Response `200`

The request was accepted.

- ExternalSyncSuccess
  - `success` true, required: Always `true` when the request was accepted.

## Other responses

- `400`: The request cannot be completed.
- `401`: Unauthorized error
- `403`: The access key lacks the permission required for this request.
- `429`: An incremental sync was requested in the last five minutes, or a full sync was requested in the last hour.

---

[API](https://skmtc.dev/resolvepay/apis/resolve-api-reference.md) - [All operations](https://skmtc.dev/resolvepay/apis/resolve-api-reference/llms.txt) - [OpenAPI document](https://skmtc.dev/resolvepay/apis/resolve-api-reference/revisions/c62edc454aaa?raw)