Developer API

Build on Qwikr. Extend anything.

A REST API designed for accountants, developers, and white-label partners.

Quick Start

Make your first request in under a minute. Authenticate with a Bearer token and start reading data.

curl https://acme.qwikr.tax/api/v1/invoices \
  -H "Authorization: Bearer {your-token}" \
  -H "Accept: application/json"

Replace acme with your tenant subdomain. Generate tokens under Settings › API Tokens.

Endpoint Reference

Every resource in the Qwikr platform is accessible via the REST API. All responses are JSON.

Contacts

Customers, suppliers, and contacts. Full CRUD support.

GET /contacts
POST /contacts
PUT /contacts/{id}
DELETE /contacts/{id}

Invoices

Full invoice lifecycle — draft, approve, send, reconcile.

GET /invoices
POST /invoices
POST /invoices/{id}/send
PUT /invoices/{id}

Bills & Expenses

Supplier documents, purchase bills, and expense claims.

GET /bills
POST /bills
GET /expenses
POST /expenses

Banking

Bank accounts, transactions, and reconciliation data.

GET /bank-accounts
GET /bank-transactions
POST /bank-transactions
POST /reconcile

VAT & MTD

VAT returns, HMRC obligations, and MTD submissions.

GET /vat/obligations
GET /vat/returns
POST /vat/returns/{id}/submit
GET /mtd/itsa/updates

Reports

P&L, balance sheet, cash flow, and custom reports.

GET /reports/profit-loss
GET /reports/balance-sheet
GET /reports/cash-flow
GET /reports/trial-balance

Authentication

The API uses Bearer tokens with scoped abilities. Tokens are created per user and carry only the permissions you grant.

Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGci...

Example scoped abilities

contacts:read
contacts:write
invoices:read
invoices:write
vat:read
vat:submit
reports:read
*

Generate tokens under Settings › API Tokens inside your Qwikr account.

Rate Limits

Limits are applied per token per minute. Exceeding the limit returns a 429 Too Many Requests response with a Retry-After header.

Standard

Starter, MTD, Practice tiers

60 req/min

Complete Tier

Complete & White-label plans

120 req/min

Enterprise

Custom limits available

Custom

Headless & White-label Frontends

Building a central SPA or white-label interface that talks to multiple tenants? Add the X-Qwikr-Tenant header to route requests to the correct tenant without switching subdomains.

curl https://api.qwikr.tax/api/v1/invoices \
  -H "Authorization: Bearer {your-token}" \
  -H "X-Qwikr-Tenant: acme" \
  -H "Accept: application/json"

Available on Practice tier and above. Required scope: the tenant must have authorised your application.

Ready to integrate?

Start with a Practice or Complete plan and get full API access from day one.

View Pricing Join the Beta