Connections

Link a platform tenant to a SYNC entity. One accounting system per tenant at a time.

List connections

GET /connections

Lists the connections the caller's platform holds. Requires connections:read.

Parameters

NameInTypeAbout
limitqueryinteger
starting_afterquerystring
statusqueryConnectionStatus
external_tenant_idquerystring

Answers

  • 200 any. A page of connections.
  • 4XX Problem. An error. `code` is stable and safe to branch on; `detail` says in plain English what
  • 5XX Problem. An error. `code` is stable and safe to branch on; `detail` says in plain English what

Start a connection

POST /connections

Sends Idempotency-Key.

Starts linking one of the platform's tenants to SYNC. The connection begins as pending; the business owner approves it at authorize_url, choosing an existing SYNC entity or creating one. On approval it becomes active and SYNC sends connection.activated. The platform must then stop posting this tenant to any other accounting system.

Returns 409 connection_exists if the tenant already has a pending or active connection. A platform in test mode can only ask an owner_email on its own team (403 platform_in_test_mode) until Vortex approves it for live. Requires connections:write.

Body

ConnectionCreate

Answers

  • 201 Connection. Connection created, awaiting owner approval.
  • 4XX Problem. An error. `code` is stable and safe to branch on; `detail` says in plain English what
  • 5XX Problem. An error. `code` is stable and safe to branch on; `detail` says in plain English what

Get a connection

GET /connections/{connection_id}

Parameters

NameInTypeAbout
connection_id requiredpathstring

Answers

  • 200 Connection. The connection.
  • 4XX Problem. An error. `code` is stable and safe to branch on; `detail` says in plain English what
  • 5XX Problem. An error. `code` is stable and safe to branch on; `detail` says in plain English what

Disconnect

POST /connections/{connection_id}/disconnect

Sends Idempotency-Key.

Ends the connection, for example because the business switched to another accounting system. SYNC rejects further events from it, keeps everything already posted, and sends connection.disconnected. Requires connections:write.

Parameters

NameInTypeAbout
connection_id requiredpathstring

Body

FieldTypeAbout
reasonstring

Up to 500 characters.

Answers

  • 200 Connection. The disconnected connection.
  • 4XX Problem. An error. `code` is stable and safe to branch on; `detail` says in plain English what
  • 5XX Problem. An error. `code` is stable and safe to branch on; `detail` says in plain English what