Build on SYNC

SYNC is an accounting system that business platforms connect to. Your platform posts what happens in plain business terms, such as a sale, a payout or a payroll run, and SYNC writes the balanced journal entries in each business’s books.

How it fits together

  1. Register your platform on Your platforms and get a test key. One key for your platform, whatever the number of businesses you serve. Getting started
  2. Connect a business. You ask SYNC to connect one of your accounts; the business’s owner approves it in SYNC and chooses which of their businesses it is. Connecting a business
  3. Post events. Sales, invoices, payments, refunds, payouts, bills and payroll runs, each once, with your own id. Posting events
  4. Listen for changes. SYNC tells you when a connection is approved or ended and when an event posts or needs a person. Webhooks

What every call has in common

  • The API lives at https://api.vortexsync.ai/v1 and speaks JSON.
  • Money is a decimal string such as "1250.00", never a number; dates are YYYY-MM-DD.
  • Every POST carries an Idempotency-Key, so a retry never does anything twice.
  • Errors have a stable code to branch on and a detail in plain English. All error codes

The full API reference is built from the same specification SYNC is tested against. A business’s own key, from the API keys page inside SYNC, uses the same API for that one business.

Questions: support@vortexsync.ai.