Aiwyn Product API Documentation

What you can build

Aggregate client financials, track expenses, and monitor project profitability in real time.

Automate categorization, invoice generation, and milestone-based billing.

Connect Aiwyn with CRM, ERP, project management, and accounting systems.

🔒

Enterprise-grade security

JWT API keys, short-lived bearer JWTs, audit trails, and robust access controls.

⚡

Fast & reliable

Low-latency APIs with 99.9% uptime targets.

📈

Designed for scale

Efficient pagination, filtering, and search to handle large datasets.

🧩

Composable

Consistent resource models for clients, invoices, payments, and projects.

We're here to help you succeed:

POST /api/v1/contacts/upsert — Upsert up to 100 contacts in one call, each linked to existing clients by external reference (pmsRef, clientRef) instead of Aiwyn ids; contacts are processed independently, so the response returns succeeded and failed lists keyed by request index. Omit pmsRef to create a new contact, omit clients to update the contact only, or send active: false to unlink a client.
POST /api/v1/event-subscriptions, PATCH /api/v1/event-subscriptions/{id}, POST /api/v1/event-subscriptions/{id}/reactivate — Payment subscriptions must set filterExpression to ownPaymentLinksOnly (payments through links the subscribing API user minted), paymentLinkOnly (any quick payment link) or allPayments (every payment); the last two need the PYMT_EVNT_ALL role. Other values are rejected; other entity types and existing rows are unchanged.
GET /api/v1/invoices/unpaid, POST /api/v1/clients/v1/link/payment — List a client's unpaid invoices by clientRef and create a single-use quick payment link for that client, locked to chosen invoices, an amount and a note (at least one argument is required); the new INVC_R and PAYLNK_C roles grant these two endpoints on their own, and API_ADMIN keeps granting them as before.