The Quickly API. Everything in the dashboard, from code too.

Quick start

3 steps — from activation to your first invoice.

curl https://www.quicklyinv.co.il/api/v1/invoices \
  -H "Authorization: Bearer qkly_live_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx" \
  -H "Content-Type: application/json" \
  -d '{
    "client_id": "<client UUID>",
    "items": [
      { "description": "Consulting", "quantity": 1, "unit_price": 500, "total": 500, "vat_rate": 17 }
    ],
    "type": "invoice"
  }'

Authentication & permissions

Every key belongs to a single business and is stored as a SHA-256 hash. A key can be revoked at any moment from the dashboard; calls with a revoked key get an immediate 401.

Endpoint catalog

All calls are under https://www.quicklyinv.co.il and return JSON in the format { success, data | error }.

More examples

Scan a receipt with an image

curl https://www.quicklyinv.co.il/api/v1/expenses/scan?commit=true \
  -H "Authorization: Bearer qkly_live_..." \
  -F "file=@receipt.jpg"

Mark an invoice as paid and issue a receipt

curl -X POST https://www.quicklyinv.co.il/api/v1/invoices/{id}/mark-paid \
  -H "Authorization: Bearer qkly_live_..." \
  -H "Content-Type: application/json" \
  -d '{ "payment_method": "credit_card" }'

Convert a quote into an invoice-receipt

curl -X POST https://www.quicklyinv.co.il/api/v1/quotes/{id}/convert \
  -H "Authorization: Bearer qkly_live_..." \
  -H "Content-Type: application/json" \
  -d '{ "type": "receipt", "payment_method": "bit" }'

Bi-monthly VAT report

curl "https://www.quicklyinv.co.il/api/v1/reports/vat?from=2026-05-01&to=2026-06-30" \
  -H "Authorization: Bearer qkly_live_..."

Quick health check (Ping)

curl https://www.quicklyinv.co.il/api/v1/ping \
  -H "Authorization: Bearer qkly_live_..."

# The response includes the scopes granted to the key — useful for quickly verifying the setup.

Register a webhook and verify the signature

# 1) Register an endpoint — you'll receive the secret once
curl -X POST https://www.quicklyinv.co.il/api/v1/webhooks \
  -H "Authorization: Bearer qkly_live_..." \
  -H "Content-Type: application/json" \
  -d '{
    "url": "https://api.example.co/quickly-events",
    "events": ["invoice.paid", "invoice.created"],
    "description": "Make.com integration"
  }'

# Response: { ..., "secret": "whsec_..." }   // save it!

2) On the receiving side — verify the signature in Node.js:

import crypto from "crypto";

function verify(secret, header, rawBody) {
  const m = Object.fromEntries(header.split(",").map(p => p.split("=")));
  const expected = crypto.createHmac("sha256", secret)
    .update(`${m.t}.${rawBody}`).digest("hex");
  return expected === m.v1 && Math.abs(Date.now()/1000 - +m.t) < 300;
}

// app.post("/quickly-events", (req, res) => {
//   const ok = verify(SECRET, req.headers["x-quickly-signature"], rawBody);
//   if (!ok) return res.status(401).end();
//   const { event, data } = JSON.parse(rawBody);
//   // ... handle event
//   res.status(200).end();
// });

OpenAPI Spec

The official spec in OpenAPI 3.0 format is available at:

https://www.quicklyinv.co.il/api/v1/openapi.json

• · ChatGPT Custom GPT — in GPT Builder under Actions → Schema → Import from URL, paste the address.
• · Postman / Insomnia — File → Import → Link.
• · SDK generation — openapi-generator-cli generate -i https://www.quicklyinv.co.il/api/v1/openapi.json -g typescript-fetch -o ./quickly-sdk

Connecting to AI assistants

The same key works with both MCP (Claude Desktop) and ChatGPT Custom GPT (OAuth).

Claude Desktop · MCP

Add the following section to claude_desktop_config.json:

{
  "mcpServers": {
    "quickly": {
      "command": "npx",
      "args": ["-y", "@quickly/mcp-server"],
      "env": {
        "QUICKLY_API_KEY": "qkly_live_..."
      }
    }
  }
}

ChatGPT · Custom GPT

In GPT Builder, under Actions → Authentication → OAuth, use the following values:

• · Authorization URL: https://www.quicklyinv.co.il/api/oauth/authorize
• · Token URL: https://www.quicklyinv.co.il/api/oauth/token
• · Scope: read write
• · OpenAPI Schema URL: https://www.quicklyinv.co.il/api/v1/openapi.json

Building your own Connector

If you're building an app (CRM, ERP, automation) and want your users to connect their Quickly account via OAuth — similar to Make.com — here's the flow.

1. Register your app at /dashboard/developers under "My apps (OAuth)". You'll receive a client_id and a client_secret (save it — it won't be shown again).
2. Send your user to this URL (replace the parameters):

   https://www.quicklyinv.co.il/api/oauth/authorize
     ?client_id=app_...
     &redirect_uri=https://your-app.com/oauth/callback
     &response_type=code
     &state=<random-csrf-token>
     &scope=read+write+reports

3. The user verifies an OTP with Quickly, approves the scopes, and returns to you with:?code=...&state=...
4. Exchange the code for a token from your server:

   curl -X POST https://www.quicklyinv.co.il/api/oauth/token \
     -d "grant_type=authorization_code" \
     -d "code=<from-redirect>" \
     -d "redirect_uri=https://your-app.com/oauth/callback" \
     -d "client_id=app_..." \
     -d "client_secret=secret_..."
   
   # Response: { access_token, refresh_token, expires_in, scope }

5. Use the access_token as a Bearer in every call to /api/v1/*. Refresh with:

   curl -X POST https://www.quicklyinv.co.il/api/oauth/token \
     -d "grant_type=refresh_token" \
     -d "refresh_token=..." \
     -d "client_id=app_..." \
     -d "client_secret=secret_..."