---
title: "List of documents"
method: GET
path: "/v2/doc/list"
tags: ["Document V2"]
---

# List of documents

`GET /v2/doc/list`

## Query parameters

- `document_type` 'invoice' | 'purchase' | 'pro_forma_invoice' | 'estimate' | 'sales_return' | 'purchase_return' | 'delivery_challan' | 'purchase_order', required
- `start_date` string, required
- `end_date` string, required
- `payment_status` 'all' | 'pending' | 'paid' | 'cancelled'
- `num_records` string
- `page` integer
- `customer_id` string

## Response `200`

Documents List fetched successfully

- ListTransactionsV2
  - `success` boolean — Success flag
  - `message` string — Message
  - `error_code` string — Error code
  - `errors` object — Error details
  - `data` ListTransactionData
    - `transactions` TransactionListModelV2[] — List of transactions
      - `serial_number` string — Invoice number assigned to document
      - `document_date` string — Transaction date [DD-MM-YYYY]
      - `customer` CustomerV2
        - `id` string, required — Unique id for each party.
        - `name` string, required — Name of the Party
        - `country_code` string — Party Phone Number Country code
        - `phone_number` string — Party Phone Number
        - `company_name` string — Company Name
        - `email` string — Party Email
        - `gstin` string — GSTIN
      - `due_date` string — Transaction date [DD-MM-YYYY]
      - `amount_paid` number — Amount Paid for the document
      - `amount_pending` number — Remaining amount to be paid for the document
      - `reference` string — Reference Text
      - `notes` string — Notes for the document
      - `terms` string — Terms and Conditions
      - `is_created_by_recurring` integer — Is the invoice created from subscriptions
      - `net_amount` number — Net amount of the transaction
      - `hash_id` string — Hash id for the document
      - `payment_status` 'paid' | 'pending' | 'cancelled' — Payment status of the document
      - `payments` PaymentV2[] — List of payments recorded for this document
        - `amount` number, required — Payment Amount
        - `method` 'cash' | 'card' | 'upi' | 'netBanking' | 'cheque' | 'emi', required — Payment method, use only specified values
        - `notes` string — Any internal notes for payment
        - `bank_details` BankDetails
          - `account_number` string, required — Account Number
          - `ifsc` string, required — IFSC Code
          - `bank_name` string, required — Bank Name
          - `branch` string, required — Branch
      - `tax_amount` number — Tax amount of the transaction
      - `total_amount` number — Total amount of the transaction
      - `total_discount` number — Discount given on this document
    - `total_records` integer — Total number of records

## Other responses

- `400` — Error in fetching documents list
- `401` — Unauthorized
- `500` — Internal Server Error

---

[API](https://skmtc.dev/getswipe/apis/swipeapi.md) · [All operations](https://skmtc.dev/getswipe/apis/swipeapi/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/getswipe/swipeapi/revisions/80fcaf1a3463/schema)