---
title: "Get Invoice"
method: GET
path: "/v2/customer_portal/invoices/"
---

# Get Invoice

`GET /v2/customer_portal/invoices/`

## Request

- Base URL: `https://dc-region.zuperpro.com/api`
- URL: `https://dc-region.zuperpro.com/api/v2/customer_portal/invoices/`
- Auth: API key in header `x-api-key`

## Query parameters

- `filter.invoice_from_date` string, date
- `filter.invoice_to_date` string, date
- `filter.invoice_due_from_date` string, date
- `filter.invoice_due_to_date` string, date
- `filter.invoice_status` 'AWAIT_PAYMENT' | 'PARTIALLY_PAID' | 'PAID' | 'BAD_DEBT' | 'CLOSED' | 'CANCELED' | 'READY_TO_INVOICE'
- `filter.payment_status` boolean
- `filter.property` string
- `filter.organization` string
- `filter.job` string
- `filter.service_contract` string
- `filter.keyword` string

## Response `200`

200

- object
  - `type` string
  - `data` object[]
    - `invoice_uid` string
    - `reference_no` string
    - `invoice_date` string
    - `due_date` string
    - `customer` object
      - `customer_uid` string
      - `customer_first_name` string
      - `customer_last_name` string
      - `customer_company_name` string
      - `customer_email` string
      - `customer_contact_no` object
        - `mobile` string
        - `home` string
        - `work` string
      - `is_active` boolean
      - `is_deleted` boolean
    - `organization` object
      - `organization_uid` string
      - `organization_name` string
      - `organization_email` string
      - `no_of_customers` integer
      - `is_deleted` boolean
    - `property` unknown
    - `prefix` string
    - `estimate` unknown
    - `job` object
      - `job_uid` string
      - `prefix` string
      - `job_title` string
      - `job_priority` string
      - `work_order_number` integer
    - `fees` unknown[]
      - unknown
    - `total` integer
    - `invoice_status` string
    - `custom_fields` object[]
      - `label` string
      - `value` string
      - `type` string
      - `module_name` string
      - `hide_to_fe` boolean
      - `hide_field` boolean
      - `read_only` boolean
      - `_id` string
    - `amount_due` integer
    - `is_paid` boolean
    - `payment_url` string
    - `financing` object
      - `promo_message` unknown
      - `is_enabled` boolean
    - `created_at` string
    - `updated_at` string
    - `invoice_no` integer
  - `current_page_records` integer
  - `total_records` integer
  - `current_page` integer
  - `total_pages` integer

## Other responses

- `400`: 400

## Changes

- **2026-11-03** `3c21bc232e16`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/zuper/apis/zuper-pro-api/changes/v2/customer_portal/invoices/get.md)

---

[API](https://skmtc.dev/zuper/apis/zuper-pro-api.md) - [All operations](https://skmtc.dev/zuper/apis/zuper-pro-api/llms.txt) - [OpenAPI document](https://skmtc.dev/zuper/apis/zuper-pro-api/revisions/3c21bc232e16?raw)