---
title: "Get payment ledger"
method: GET
path: "/v2/vendor/ledger"
tags: ["Vendor V2"]
---

# Get payment ledger

`GET /v2/vendor/ledger`

## Query parameters

- `start_date` string, required
- `end_date` string, required
- `vendor_id` string, required
- `num_records` integer
- `page` integer

## Response `200`

Payment details fetched successfully

- LedgerDataResponseV2
  - `success` boolean — Success flag
  - `message` string — Response message
  - `error_code` string — Error Code
  - `errors` object — Errors
  - `data` LedgerData
    - `closing_balance` number — Balance as of this record
    - `is_paid` integer — Paid
    - `total_records` integer — Number of records
    - `ledger` Ledger[]
      - `amount_pending` number — Amount pending
      - `balance` number — Balance as of this record
      - `notes` string — Notes
      - `created_time` string — Created Time of the Payment [YYYY-MM-DD HH:MM:SS] GMT
      - `mode` string — Payment Mode
      - `date` string — Payment Date
      - `status` string — Payment Status
      - `serial_number` string — Serial Number
      - `total_amount` number — Total Amount

## Other responses

- `400` — Error in fetching payment details
- `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)
