Skip to main content

Update Sync Settings

PUT 
/api/accounting/sync-settings

Updates the accounting sync settings. Unsubmitted types are preserved (partial updates supported).

Required scope: accounting:write

Grant this scope to your token under Settings → Developer → Personal Access Tokens.

Authentication: Requires Bearer token

Each key of sync_controls_by_type must be a valid transaction type value — call GET /api/accounting/sync-settings/types for the current list. An unknown key returns 422.

Fields per type:

  • enabled (boolean, required) — whether documents of this type sync to the accounting provider
  • sync_start_date (date, nullable) — documents dated before this are never synced

Saving a type gives it a control of its own, which ends any inheritance from the type it was split out of (inventory_revaluation from inventory_adjustment).

Both top-level keys are optional — send either or both:

  • sync_controls_by_type — per-transaction-type auto-sync toggles (as before)
  • mirror_sync_controls (Xero only) — {"bank_transactions": {"enabled": bool}, "payments": {"enabled": bool}}; enables the nightly mirror download for that entity. Unsubmitted keys keep their stored state. A request with neither key returns 422.

Request​

Responses​

OK

Response Headers
    Content-Type