API reference

Overview

Aqili Next is API-first: everything you can do in the product is backed by a REST API over HTTPS that returns JSON. Build integrations, sync data to your warehouse, or automate workflows against live data — no batch export required.

Authentication

Requests authenticate with a bearer token. Operators issue scoped API keys from settings and pass them in the Authorization header:

Authorization: Bearer <your-api-key>

Keys are scoped to least privilege and can be rotated or revoked at any time. All API use is recorded in the audit log.

Conventions

• Resource-oriented URLs under /api/v1/.
• Standard HTTP verbs and status codes.
• Cursor-based pagination on list endpoints.
• ISO 8601 timestamps and minor-unit currency amounts.

Idempotency

Write requests accept an Idempotency-Key header so retries are safe — submitting the same key twice won't create duplicate records. This is the same mechanism the product uses internally for actions like demo requests and payments.

Core resources

The API exposes the same domain the product is built on:

• Locations, accounts, parkers, and rate codes
• Invoices and billing runs
• Payments, deposits, and refunds
• Reports (aged balance, open invoices) and GL exports

Webhooks

Subscribe to events — invoice issued, payment applied, billing run posted — to keep external systems in sync in near real time. Webhook deliveries are signed and retried, and you can inspect delivery history in settings. Talk to us if you'd like full endpoint reference docs for your integration.