---
title: "Get all Invoice"
method: GET
path: "/invoice"
---

# Get all Invoice

`GET /invoice`

## Query parameters

- `page` string
- `count` string
- `sort` 'DESC' | 'ASC'
- `sort_by` 'invoice_no' | 'reference_no' | 'created_at' | 'invoice_date' | 'due_date'
- `filter.keyword` string
- `filter.is_deleted` boolean
- `filter.is_paid` boolean
- `filter.is_active` boolean
- `filter.job` string
- `filter.estimate` string
- `filter.customer` string
- `filter.payment_term` string
- `filter.payment_mode` string
- `filter.due_from_date` string, date
- `filter.due_to_date` string, date
- `filter.created_from_date` string, date
- `filter.created_to_date` string, date
- `filter.invoice_from_date` string, date
- `filter.invoice_to_date` string, date
- `filter.created_by` string
- `filter.updated_at` string, date
- `filter.updated_at_from` string, date
- `filter.updated_at_to` string, date
- `filter.status` 'DRAFT' | 'AWAIT_PAYMENT' | 'PARTIALLY_PAID' | 'PAID' | 'BAD_DEBT' | 'ARCHIVED' | 'CLOSED' | 'CANCELED' | 'READY_TO_INVOICE'
- `filter.invoice_uid` string
- `filter.over_due` boolean
- `filter.property` string
- `filter.organization` string
- `filter.team_uid` string
- `filter.custom_field` string
- `filter.has_card_on_file` boolean
- `filter.financing` boolean
- `filter.tags` string
- `filter.service_contract` string
- `filter.project` string
- `filter.business_unit` string

## Response `200`

200

- object
  - `type` string
  - `data` object[]
    - `invoice_uid` string
    - `invoice_date` string
    - `due_date` string
    - `customer` object
      - `customer_uid` string
      - `customer_first_name` string
      - `customer_last_name` string
      - `customer_organization` object
        - `is_deleted` boolean
        - `is_active` boolean
        - `organization_billing_address` object
          - `city` string
          - `state` string
          - `street` string
          - `landmark` string
          - `_id` string
        - `organization_address` object
          - `city` string
          - `state` string
          - `street` string
          - `landmark` string
          - `geo_cordinates` number[]
          - `_id` string
        - `organization_email` unknown
        - `organization_description` string
        - `organization_logo` unknown
        - `organization_name` string
        - `organization_uid` string
      - `customer_company_name` string
      - `customer_email` string
      - `is_active` boolean
      - `is_deleted` boolean
      - `customer_contact_no` object
        - `mobile` string
        - `home` string
        - `work` string
    - `organization` object
      - `is_deleted` boolean
      - `organization_billing_address` object
        - `city` string
        - `state` string
        - `street` string
        - `landmark` string
        - `_id` string
      - `organization_address` object
        - `city` string
        - `state` string
        - `street` string
        - `landmark` string
        - `geo_cordinates` number[]
        - `_id` string
      - `no_of_customers` integer
      - `organization_email` unknown
      - `organization_description` string
      - `organization_logo` unknown
      - `organization_name` string
      - `organization_uid` string
    - `property` object
      - `is_deleted` boolean
      - `property_address` object
        - `city` string
        - `state` string
        - `street` string
        - `country` string
        - `landmark` string
        - `zip_code` string
        - `geo_cordinates` number[]
        - `_id` string
      - `property_image` string
      - `no_of_jobs` integer
      - `property_name` string
      - `property_uid` string
    - `prefix` string
    - `total` integer
    - `tags` unknown[]
      - unknown
    - `invoice_status` string
    - `custom_fields` unknown[]
      - unknown
    - `service_contract` object
      - `contract_uid` string
      - `ref_no` string
      - `contract_name` string
      - `description` string
      - `start_date` string
      - `end_date` string
      - `is_deleted` boolean
      - `contract_number` integer
    - `is_paid` boolean
    - `is_deleted` boolean
    - `is_active` boolean
    - `created_by` object
      - `user_uid` string
      - `first_name` string
      - `last_name` string
      - `email` string
      - `external_login_id` unknown
      - `home_phone_number` unknown
      - `designation` string
      - `emp_code` string
      - `prefix` unknown
      - `work_phone_number` unknown
      - `mobile_phone_number` unknown
      - `profile_picture` string
      - `hourly_labor_charge` integer
      - `is_active` boolean
      - `is_deleted` boolean
      - `created_at` string
      - `updated_at` string
    - `financing` object
      - `is_enabled` boolean
      - `promo_message` unknown
    - `created_at` string
    - `updated_at` string
    - `invoice_no` integer
    - `id` string
  - `total_records` integer
  - `current_page` integer
  - `total_pages` integer

## Other responses

- `400` — 400

---

[API](https://skmtc.net/zuper/apis/zuper-pro-api.md) · [All operations](https://skmtc.net/zuper/apis/zuper-pro-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/zuper/zuper-pro-api/revisions/c7b8028a05de/schema)
