Integrations API

The integrations surface connects AlgaPSA to outside systems. Every endpoint lives under /integrations/{provider} and follows the same shape: authorize the provider, confirm the connection is healthy, map AlgaPSA records to the provider's, then sync. QuickBooks is the provider available today.

Connect a provider

A connection starts with OAuth. Call POST /integrations/quickbooks/oauth/initiate to get an authorization URL, then hand the provider's response back through POST /integrations/quickbooks/oauth/callback. Once tokens are stored, GET /integrations/quickbooks/connection/status tells you whether the link is live, and POST /integrations/quickbooks/connection/refresh renews tokens before they expire. To drop the connection, use DELETE /integrations/quickbooks/oauth/disconnect.

Map before you sync

Syncing fails on records the provider can't place, so configure mappings first. The generic GET /integrations/quickbooks/mappings and POST /integrations/quickbooks/mappings handle data mappings by ID; dedicated endpoints cover the common cases — accounts via PUT /integrations/quickbooks/accounts/mappings, tax codes via PUT /integrations/quickbooks/tax-codes/mappings, and customers via GET /integrations/quickbooks/customers/mappings.

Run and watch syncs

Kick off a sync with POST /integrations/quickbooks/sync/full or POST /integrations/quickbooks/sync/bulk, then poll GET /integrations/quickbooks/sync/status/{sync_id}. Cancel a running job at POST /integrations/quickbooks/sync/{sync_id}/cancel or replay a failed one at POST /integrations/quickbooks/sync/{sync_id}/retry. Connection health and the diagnostics check at POST /integrations/quickbooks/diagnostics are worth wiring into your own monitoring. For everything QuickBooks-specific — the chart of accounts, items, terms, invoice and payment sync — see the QuickBooks API.

Endpoints

Every endpoint links through to its full parameters, request and response schemas, and code samples.