Quickstart

This guide takes you from zero to a real invoice PDF using two API calls. All you need is a Swipe account.

API calls run against your live Swipe account — documents you create here are real. You can cancel a test document at any time using its hash_id.

Get your API key

Sign in to Swipe and open the API Integration section of your dashboard. Generate an API key and store it securely — it is sent as a Bearer token with every request. See Authentication for details.

Create your first invoice

Send a POST request to /v2/doc with a minimal payload — a date, a document type, a customer, and one line item. Replace YOUR_API_KEY with the key from step 1.

curl --request POST \
  --url https://app.getswipe.in/api/partner/v2/doc \
  --header "Authorization: Bearer YOUR_API_KEY" \
  --header "Content-Type: application/json" \
  --data '{
    "document_type": "invoice",
    "document_date": "26-08-2026",
    "party": {
      "id": "CUST001",
      "type": "customer",
      "name": "Test Customer"
    },
    "items": [
      {
        "id": "ITEM001",
        "item_type": "Product",
        "name": "Test Product",
        "quantity": 1,
        "unit_price": 100.0,
        "tax_rate": 18.0,
        "net_amount": 100.0,
        "price_with_tax": 118.0,
        "total_amount": 118.0
      }
    ]
  }'

import requests

API_KEY = "YOUR_API_KEY"

payload = {
    "document_type": "invoice",
    "document_date": "26-08-2026",
    "party": {"id": "CUST001", "type": "customer", "name": "Test Customer"},
    "items": [
        {
            "id": "ITEM001",
            "item_type": "Product",
            "name": "Test Product",
            "quantity": 1,
            "unit_price": 100.0,
            "tax_rate": 18.0,
            "net_amount": 100.0,
            "price_with_tax": 118.0,
            "total_amount": 118.0,
        }
    ],
}

response = requests.post(
    "https://app.getswipe.in/api/partner/v2/doc",
    headers={"Authorization": f"Bearer {API_KEY}"},
    json=payload,
)
print(response.json())

const API_KEY = "YOUR_API_KEY";

const payload = {
  document_type: "invoice",
  document_date: "26-08-2026",
  party: { id: "CUST001", type: "customer", name: "Test Customer" },
  items: [
    {
      id: "ITEM001",
      item_type: "Product",
      name: "Test Product",
      quantity: 1,
      unit_price: 100.0,
      tax_rate: 18.0,
      net_amount: 100.0,
      price_with_tax: 118.0,
      total_amount: 118.0,
    },
  ],
};

const response = await fetch("https://app.getswipe.in/api/partner/v2/doc", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${API_KEY}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify(payload),
});
console.log(await response.json());

The customer CUST001 and item ITEM001 don’t need to exist yet — Swipe creates them automatically from the details you send, and reuses them the next time you send the same IDs. See Create a document for every available field.

Grab the hash_id from the response

A successful call returns the document’s identifiers. The hash_id is the document’s address in every other API call — fetching, editing, cancelling, and downloading the PDF.

{
  "success": true,
  "message": "Document created successfully",
  "error_code": "",
  "errors": {},
  "data": {
    "hash_id": "PUlgCNPb",
    "serial_number": "INV-1",
    "irn": "",
    "qr_code": ""
  }
}

Download the invoice PDF

Pass the hash_id to the PDF endpoint — the response is the PDF file itself.

curl --request GET \
  --url https://app.getswipe.in/api/partner/v2/doc/pdf/PUlgCNPb \
  --header "Authorization: Bearer YOUR_API_KEY" \
  --output invoice.pdf

See it in your dashboard

The invoice also appears in your Swipe dashboard alongside documents created in the app — the API and the dashboard work on the same data.

Next steps

API conventions

Response format, error codes, dates, list endpoints, and rate limits.

Create a document

The full document payload — taxes, discounts, serial numbers, and more.

Webhooks

Get notified in real time when documents or inventory change.

E-Invoices

Generate GST-compliant e-invoices with IRN and QR codes.

Get Started

Guides

Resources

Documents

Payments

E-Way Bills

Customers

Vendors

Products

Inventory

Subscriptions

Utility

Next steps

API conventions

Create a document

Webhooks

E-Invoices

​Next steps

API conventions

Create a document

Webhooks

E-Invoices

Next steps