---
title: "List Invoice"
method: GET
path: "/invoice"
---

# List Invoice

`GET /invoice`

## Query parameters

- `page_number` number, float
- `filter.contact_id` integer
- `page_size` integer
- `filter.payment_status` 'Paid' | 'Part Paid' | 'Not Paid'
- `filter.invoice_status` 'Deleted'
- `filter.date_from` string
- `filter.date_to` string

## Response `200`

200

- object
  - `success` boolean
  - `meta` object
    - `total_count` integer
  - `data` object[]
    - `invoice_id` integer
    - `invoice_number` string
    - `invoice_date` string
    - `validity_date` string
    - `gst_type` integer
    - `seller_info` object
      - `business_name` string
      - `gstin` string
      - `branch_id` string
      - `address` object
        - `address_line_1` string
        - `address_line_2` string
        - `city` string
        - `state` string
        - `country` string
        - `pincode` string
    - `seller_branch_id` integer
    - `customer_info` object
      - `id` integer
      - `name` string
      - `email` string
      - `mobile` string
      - `business_name` string
      - `gstin` string
      - `pos` string
      - `billing_details` object
        - `bill_city` string
        - `bill_addr1` string
        - `bill_addr2` string
        - `bill_gstin` string
        - `bill_state` string
        - `bill_country` string
        - `bill_pincode` string
      - `shipping_details` object
        - `ship_city` string
        - `ship_addr1` string
        - `ship_addr2` string
        - `ship_gstin` string
        - `ship_state` string
        - `ship_country` string
        - `ship_pincode` string
    - `invoice_item` object[]
      - `product_id` integer
      - `variant_id` integer
      - `item_name` string
      - `item_description` string
      - `item_type` integer
      - `item_code` integer
      - `quantity` integer
      - `units` string
      - `rate` integer
      - `taxable_amt` integer
      - `non_taxable_amt` integer
      - `discount` integer
      - `gst_rate` integer
      - `sgst_amt` integer
      - `cgst_amt` integer
      - `igst_amt` integer
      - `cess_amt` integer
      - `tax_info` object
        - `gst_type` integer
        - `cess_rate` integer
        - `cess_type` string
        - `cgst_rate` integer
        - `igst_rate` integer
        - `sgst_rate` integer
        - `cess_amount` integer
        - `cgst_amount` integer
        - `igst_amount` integer
        - `sgst_amount` integer
      - `discount_type` string
      - `custom_fields` object[]
        - `label` string
        - `value` string
      - `item_total_amt` integer
    - `invoice_others` object[]
    - `total_taxable_amount` integer
    - `total_non_taxable_amount` integer
    - `total_gst_amount` integer
    - `total_cess_amount` integer
    - `total_adjust_amount` integer
    - `total_addvalue_amount` integer
    - `total_tcs_amount` integer
    - `total_amount` integer
    - `payable_amount` integer
    - `reverse_charge_applied` integer
    - `added_by` integer
    - `added_on` string
    - `invoice_status` integer
    - `payment_status` integer
    - `payment_info` object
      - `rid` string
    - `paid_amount` integer
    - `export_details` object
      - `export_lut` integer
      - `export_port` string
      - `export_type` integer
      - `export_bill_no` string
      - `special_supply` string
      - `export_bill_date` string
    - `billing_currency` string
    - `terms_conditions` string
    - `notes` string
    - `billing_currency_info` object
      - `name` string
      - `exchange_rate` integer
      - `exchnage_time` string
    - `bank_id` integer
    - `tax_info` object
      - `gst_type` integer
      - `cess_amount` integer
      - `cgst_amount` integer
      - `igst_amount` integer
      - `sgst_amount` integer
      - `total_tcs_amt` integer
    - `data_source` integer
    - `auto_mode` integer
    - `custom_fields` object[]
    - `recon_details` object
      - `receipt` object[]
        - `receipt_id` string
        - `receipt_date` string
        - `amount` integer
      - `creditnote` object[]
    - `url` string
  - `error` object[]
  - `message` string

## Other responses

- `400` — 400
- `401` — 401
- `403` — 403
- `500` — 500
- `501` — 501
- `502` — 502
- `503` — 503

---

[API](https://skmtc.dev/ledgers/apis/authentication.md) · [All operations](https://skmtc.dev/ledgers/apis/authentication/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/ledgers/authentication/revisions/605f28ef08ef/schema)