Invoice generation by REST

Quickstart

Three steps from zero to a generated invoice.

1. 1

   Generate an API key

   Sign in, upgrade to Pro, then create a key from the Manage keys section below. Keys are shown once at creation, so store them somewhere safe.

2. 2

   Make your first request

   Hit the /preview endpoint to validate your payload and see the calculated totals.

   cURLNode.jsPython

   Copy

   curl -X POST https://invoeze.in/api/v1/invoice/preview \
     -H "Authorization: Bearer YOUR_API_KEY" \
     -H "Content-Type: application/json" \
     -d '{
          "invoiceNumber": "INV-001",
          "date": "2026-04-19",
          "currency": "INR",
          "sender": { "name": "Acme Studio", "gstin": "29ABCDE1234F1Z5" },
          "client": { "name": "Globex", "gstin": "27ABCDE5678G2Z9" },
          "lineItems": [
            { "description": "Logo design", "quantity": 1, "rate": 25000 }
          ],
          "tax": { "gstEnabled": true, "gstType": "igst", "gstRate": 18, "tdsEnabled": true, "tdsRate": 10 }
        }'

3. 3

   Inspect the response

   All responses follow the same shape:

   {
     "success": true,
     "data": { ... },
     "error": null
   }

   When success is false, data is null and error is a human-readable message.

Endpoints

Base URL: https://invoeze.in/api/v1

curl -X POST https://invoeze.in/api/v1/invoice/preview \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
       "invoiceNumber": "INV-001",
       "date": "2026-04-19",
       "currency": "INR",
       "sender": { "name": "Acme Studio", "gstin": "29ABCDE1234F1Z5" },
       "client": { "name": "Globex", "gstin": "27ABCDE5678G2Z9" },
       "lineItems": [
         { "description": "Logo design", "quantity": 1, "rate": 25000 }
       ],
       "tax": { "gstEnabled": true, "gstType": "igst", "gstRate": 18, "tdsEnabled": true, "tdsRate": 10 }
     }'

{
  "success": true,
  "data": {
    "subtotal": 25000,
    "cgst": 0,
    "sgst": 0,
    "igst": 4500,
    "tdsDeduction": 2500,
    "total": 27000
  },
  "error": null
}

curl -X POST https://invoeze.in/api/v1/invoice/generate \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d @invoice.json \
  | jq -r '.data.pdfBase64' \
  | base64 -d > invoice.pdf

{
  "success": true,
  "data": {
    "filename": "invoice-INV-001-Globex.pdf",
    "mimeType": "application/pdf",
    "pdfBase64": "JVBERi0xLjQK..."
  },
  "error": null
}

Rate limits

• 1,000 requests per month, per key, included with Invoeze Pro. Both /preview and /generate count toward the same bucket.
• The counter is per-key and increments on every successful authenticated request. 5xx server errors do not count against your quota.
• Every response includes X-RateLimit-Limit and X-RateLimit-Remaining headers so you can budget proactively.
• Need a higher ceiling? Email hello@invoeze.in and we'll quote a per-month limit that fits your volume.

Errors

HTTP status codes follow the usual conventions. The body shape is identical for every error: success: false with a string error and an optional details object.

{
  "success": false,
  "error": "Invalid invoice payload",
  "details": {
    "issues": [
      { "path": ["lineItems", 0, "rate"], "message": "Expected number, received string" }
    ]
  }
}

{
  "success": false,
  "error": "Missing or invalid API key"
}

{
  "success": false,
  "error": "Rate limit exceeded"
}

{
  "success": false,
  "error": "Failed to generate PDF"
}

Manage keys

Use these keys in the Authorization: Bearer … header.