---
title: "Get Customer Invoice Details"
method: GET
path: "/v2/customer_portal/invoices/{invoice_uid}"
---

# Get Customer Invoice Details

`GET /v2/customer_portal/invoices/{invoice_uid}`

## Request

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

## Path parameters

- `invoice_uid` string, required

## Response `200`

200

- object
  - `type` string
  - `data` object
    - `invoice_uid` string
    - `reference_no` string
    - `invoice_date` string
    - `due_date` string
    - `property` unknown
    - `prefix` string
    - `project` unknown
    - `estimate` unknown
    - `customer_billing_address` object
      - `landmark` string
      - `city` string
      - `state` string
      - `street` string
      - `zip_code` string
      - `geo_cordinates` number[]
      - `first_name` string
      - `last_name` string
      - `phone_number` string
      - `email` string
    - `customer_service_address` object
      - `landmark` string
      - `city` string
      - `state` string
      - `street` string
      - `zip_code` string
      - `geo_cordinates` number[]
      - `first_name` string
      - `last_name` string
      - `phone_number` string
      - `email` string
    - `job` object
      - `job_uid` string
      - `prefix` string
      - `job_title` string
      - `job_priority` string
      - `work_order_number` integer
    - `line_items` object[]
      - `line_item_uid` string
      - `line_item_type` string
      - `product_id` string
      - `product_uid` string
      - `location_uid` string
      - `image` string
      - `name` string
      - `brand` string
      - `specification` string
      - `uom` string
      - `description` string
      - `quantity` integer
      - `unit_price` integer
      - `associated_products` unknown[]
        - unknown
      - `discount` integer
      - `serial_nos` unknown[]
        - unknown
      - `discount_type` string
      - `total` integer
      - `tax` object
        - `tax_name` string
        - `tax_rate` integer
        - `tax_amount` integer
        - `tax_exempt` boolean
        - `tax_exempt_remarks` unknown
        - `tax_exempt_number` unknown
        - `entity_use_code` unknown
      - `_id` string
      - `taxes` unknown[]
        - unknown
    - `tax_exempt` boolean
    - `sub_total` integer
    - `total_markup` integer
    - `discount` object
      - `type` string
      - `value` integer
      - `percent` integer
      - `discount_applicability` string
      - `discount_label` string
    - `fees` unknown[]
      - unknown
    - `total` integer
    - `total_discount` integer
    - `remarks` string
    - `tax` object[]
      - `tax_uid` string
      - `tax_name` string
      - `tax_percent` integer
      - `tax_amount` integer
      - `_id` string
    - `taxation_meta` object
      - `tax_provider` string
      - `message` object
        - `error` object
          - `code` string
          - `message` string
          - `target` string
          - `details` object[]
            - `code` string
            - `number` integer
            - `message` string
            - `description` string
            - `faultCode` string
            - `faultSubCode` string
            - `helpLink` string
            - `refersTo` string
            - `severity` string
      - `current_status` string
      - `status_history` object[]
        - `status` string
        - `date` string
        - `_id` string
    - `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
    - `status_history` object[]
      - `status_name` string
      - `done_by_type` string
      - `created_at` string
    - `amount_paid` integer
    - `amount_due` integer
    - `is_paid` boolean
    - `public_url` string
    - `payment_url` string
    - `financing` object
      - `promo_message` unknown
      - `is_enabled` boolean
    - `attachments` unknown[]
      - unknown
    - `payment_history` object[]
      - `amount` integer
      - `payment_mode` object
        - `payment_mode_uid` string
        - `payment_mode_name` string
        - `payment_mode_type` string
        - `payment_mode_description` string
        - `is_deleted` boolean
        - `created_at` string
        - `updated_at` string
      - `payment_transaction` object
        - `payment_transaction_uid` string
        - `currency` string
        - `amount` integer
        - `description` string
        - `action_uid` string
        - `type` string
        - `source` string
        - `status` string
        - `created_at` string
        - `updated_at` string
      - `remarks` string
      - `reference_no` string
      - `is_void` boolean
      - `payment_date` string
      - `done_by_type` string
      - `_id` string
      - `created_at` string
    - `created_at` string
    - `updated_at` string
    - `invoice_no` integer
    - `__v` integer
    - `invoice_no_string` string

## Other responses

- `404`: 404

## Changes

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

[Operation history](https://skmtc.dev/zuper/apis/zuper-pro-api/changes/v2/customer_portal/invoices/:invoice_uid/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)