> ## Documentation Index
> Fetch the complete documentation index at: https://developers.getswipe.in/llms.txt
> Use this file to discover all available pages before exploring further.

# Introduction

> Integrate invoicing, payments, and GST compliance into your application with the Swipe API.

Swipe is a simple and powerful invoicing, payments, and GST platform trusted by 2 million+ businesses. The Swipe API is RESTful and JSON-based: your application creates invoices, records payments, and stays GST-compliant, while everything shows up in the [Swipe dashboard](https://app.getswipe.in) in real time.

<img className="block dark:hidden" src="https://mintcdn.com/swipe/ZOyvFX50eH4DT_Wr/images/hero-light.svg?fit=max&auto=format&n=ZOyvFX50eH4DT_Wr&q=85&s=9ff1383e5ed67c4ec90caee3b8cadbd6" alt="Hero Light" width="1008" height="390" data-path="images/hero-light.svg" />

<img className="hidden dark:block" src="https://mintcdn.com/swipe/ZOyvFX50eH4DT_Wr/images/hero-dark.svg?fit=max&auto=format&n=ZOyvFX50eH4DT_Wr&q=85&s=999803ca9d216600c81d43f138dada08" alt="Hero Dark" width="1008" height="390" data-path="images/hero-dark.svg" />

## Get set up

<Steps>
  <Step title="Create an account">
    Sign up on [Swipe](https://app.getswipe.in) — the dashboard and the API work on the same data.
  </Step>

  <Step title="Generate your API key">
    In the [API Integration](https://app.getswipe.in/user?tab=api_integration) section of your
    dashboard. See [Authentication](/authentication) for how requests are signed.
  </Step>

  <Step title="Make your first call">
    Follow the [Quickstart](/quickstart) — create an invoice and download its PDF in two requests,
    or try any endpoint in the interactive playground on its reference page.
  </Step>

  <Step title="Customize your invoices (optional)">
    Pick templates and document settings on the [settings page](https://app.getswipe.in/user?tab=settings\&sub_tab=document\&doc_tab=general) —
    PDFs generated by the API use them.
  </Step>
</Steps>

## What you can build with

<CardGroup cols={2}>
  <Card title="Documents" icon="file-invoice" href="/document">
    Invoices, purchases, estimates, returns — created, edited, and rendered as PDFs.
  </Card>

  <Card title="Customers & Vendors" icon="users" href="/customer">
    The parties on your documents, mapped to your own IDs, each with a ledger.
  </Card>

  <Card title="Payments" icon="credit-card" href="/payment">
    Record what customers pay and settle it against documents.
  </Card>

  <Card title="Products & Inventory" icon="boxes-stacked" href="/product">
    Your catalog, with per-warehouse stock tracking.
  </Card>

  <Card title="Subscriptions" icon="repeat" href="/subscriptions">
    Recurring invoices generated on a schedule.
  </Card>

  <Card title="E-Invoices & E-Way Bills" icon="file-circle-check" href="/einvoices">
    GST compliance — IRN, QR codes, and transport documents.
  </Card>

  <Card title="Webhooks" icon="bolt" href="/webhooks">
    Real-time notifications for document and inventory events.
  </Card>

  <Card title="API conventions" icon="list-check" href="/api-conventions">
    Response envelope, errors, IDs, dates, and rate limits.
  </Card>
</CardGroup>

## Explore the API your way

* **Playground** — every reference page has a **Try it** button with your key.
* **Postman** — fork the [Swipe collection](https://god.gw.postman.com/run-collection/43895811-b7327b9d-1e50-4fed-af6f-660a918aa817?action=collection%2Ffork\&source=rip_markdown\&collection-url=entityId%3D43895811-b7327b9d-1e50-4fed-af6f-660a918aa817%26entityType%3Dcollection%26workspaceId%3D5d3fc3f0-668c-499e-833b-03222666ba2a).
* **AI tools** — every page has a contextual menu (top right) to copy it as Markdown or open it in ChatGPT, Claude, or your editor; the full docs are also available as [llms.txt](https://developers.getswipe.in/llms.txt).

Questions? Reach the team via [Support](https://app.getswipe.in/user?tab=api_integration) or the [community forum](https://community.getswipe.in/c/api-integration/14).