API reference
Base URL https://api.vortexsync.ai/v1. Version 1.0.0-draft. Built from the same specification the API is tested against; download it for your own tools.
SYNC ("SYNC") is an accounting system that business platforms connect to. Every platform that posts to SYNC is a customer of this API, on the same terms as any outside developer. That includes Vortex products such as Payroll Genie, MerchantLink, KOI POS and the beauty supplier inventory app.
One accounting system at a time
A platform tenant (one business inside a platform) syncs with exactly one accounting system at a time. When a connection to SYNC becomes active, the platform must stop posting that tenant's activity to any other accounting system. When the connection is disconnected, SYNC accepts no more events from it. SYNC allows one active connection per (platform, external_tenant_id) pair and sends connection.activated and connection.disconnected webhooks so the platform can switch its own setting.
Business events, not journal lines
Platforms post business events (a sale, a payout, a payroll run) in plain business terms. SYNC validates each event, applies the entity's posting rules and writes a balanced journal entry. Callers never need accounting knowledge. Accountants and accounting tools can post manual journal entries through /journal-entries.
Conventions
- Money is a decimal string with up to 4 decimal places (
"1250.00"), never a float. Every money-bearing object carries an ISO 4217currency. - Dates are ISO 8601. Business dates are
YYYY-MM-DD; timestamps are UTC. - Idempotency: every POST requires an
Idempotency-Keyheader. Replaying a key with the same body returns the original response; a different body returns 409. Events also carryexternal_id, which is unique per connection. - Pagination: list endpoints take
limit(1-100, default 25) andstarting_after(an object id) and returnhas_more. - Errors use RFC 9457 problem details (
application/problem+json). - Versioning: the major version is in the path. Breaking changes ship as a new major version with at least 12 months' notice.
- Immutability: posted journal entries are never edited or deleted. Corrections are reversals.
- MCP: the same operations are published through SYNC's MCP server for AI agents, under the same scopes.
By area
- Connections
- Link a platform tenant to a SYNC entity. One accounting system per tenant at a time.
- Entities
- Companies (legal entities) the caller can access.
- Events
- Post business events. SYNC turns each into a balanced journal entry.
- Journal entries
- The general ledger. Read entries, post manual entries, reverse entries.
- Forecasts
- Cash and profit forecasts from the books, with what-if scenarios.
- KPIs
- KPIs worked out from the books, outside data from other systems, and dashboards.
- Expenses
- Expenses already paid, entered many at a time. Each is its own journal entry.
- Mileage
- A business mileage log priced at the IRS standard mileage rate, and recording it in the books.
- Accounts
- Chart of accounts.
- Dimensions
- Tags such as location, department, job, event and provider.
- Contacts and items
- Customers, vendors and items referenced by events.
- Banking
- Bank accounts, bank connections through Stripe, statement uploads and staged bank transactions.
- Reconciliation
- Reconcile bank accounts to statement balances.
- Periods
- Accounting periods and close.
- Proposals
- Journal entries suggested by an AI assistant, and what AI agents sent for approval, waiting for a person.
- Reports
- Financial statements and ledger reports.
- Imports
- Bring books in from any previous system by file.
- Webhooks
- Subscribe to changes.
- Estimated tax
- Plan quarterly estimated income tax from the books and record the payments.
- Sales tax
- Send finished sales tax returns to a connected filing service, which reports back when it has filed and paid.

