Integrations

Connect external financial accounts via Plaid or custom integrations. The system supports checking, savings, credit card, loan, and investment accounts. Transaction sync is cursor-based with automatic retry on rate limits (429) and transient errors.

Plaid Link Flow

1. Create link token — POST /api/plaid/link-token returns a short-lived token
2. User completes Plaid Link — browser-side widget
3. Exchange token — POST /api/plaid/exchange-token stores the permanent access token
4. Sync transactions — POST /api/plaid/sync or automatic via the sync-connections scheduled job

Connections API

The connections API manages integration connections and provides sync status visibility. All endpoints require entityId.

List Connections

GET /api/connections?entityId=...

Returns all connections for the entity with their current status, last sync time, provider, and configuration.

Sync Summary

GET /api/connections?entityId=...&action=summary

Returns a lightweight overview for dashboards and status indicators:

Sync Logs & Health

GET /api/connections?entityId=...&action=logs&connectionId=...&limit=20
GET /api/connections?entityId=...&action=health&connectionId=...

Write Operations

All write operations use POST /api/connections:

Real-Time Sync Events

Sync progress is broadcast via Pusher on the entity-{entityId} channel:

Import Batches API

Query aggregated import batch history or drill down into a specific batch.

List Batches

GET /api/import-batches?entityId=...&limit=30&offset=0

Returns batches grouped by importBatchId with:

Batch Drill-Down

GET /api/import-batches?entityId=...&batchId=batch-uuid

Returns up to 200 individual transactions within the batch, each with date, description, amount, currency, status, counterparty, and match info.

Plaid Endpoints

curl -X POST "https://app.axiomatic.software/api/plaid/link-token" \  -H "Content-Type: application/json" \  -d '{    "entityId": "156e622c-6cdf-4c27-9bc9-2f2db69919f5"  }'

{
  "linkToken": "string"
}

{
  "error": "string"
}

curl -X POST "https://app.axiomatic.software/api/plaid/exchange-token" \  -H "Content-Type: application/json" \  -d '{    "entityId": "156e622c-6cdf-4c27-9bc9-2f2db69919f5",    "publicToken": "string",    "institutionId": "string"  }'

{}

{
  "error": "string"
}

curl -X POST "https://app.axiomatic.software/api/plaid/sync" \  -H "Content-Type: application/json" \  -d '{    "entityId": "156e622c-6cdf-4c27-9bc9-2f2db69919f5",    "linkedAccountId": "61224e78-a02f-4040-ac7e-3dd716a4b677"  }'

{
  "added": 0,
  "modified": 0,
  "removed": 0,
  "duplicatesSkipped": 0
}

{
  "error": "string"
}