---
title: "Preview invoice report"
method: GET
path: "/coa/api/v1/invoice/report/preview"
tags: ["Accounts Receivable"]
---

# Preview invoice report

`GET /coa/api/v1/invoice/report/preview`

Execute invoice report preview from query params.

:param request: HTTP request with report configuration
:return: Paginated response or CSV stream

## Query parameters

- `aggregation_fields` string
- `client_id` string
- `contract_id` string
- `currency` string
- `department_id` string
- `end_date` string
- `entity_id` string
- `group_fields` string
- `group_keys` string
- `include_totals` boolean
- `limit` integer
- `mode` string
- `offset` integer
- `payment_status` string
- `pivot_fields` string
- `product_id` string
- `shouldPivot` boolean
- `start_date` string

## Response `200`

- InvoiceReportResponse — Output schema for invoice report responses.
  - `count` integer, required — Total rows before pagination
  - `next` string, nullable, required — Next page URL (null for datatable pagination)
  - `previous` string, nullable, required — Previous page URL
  - `results` InvoiceReportResultRow[], required — Paginated result rows
    - `filter_params` object, required — Filter parameters for drilldown navigation
    - `group_id` integer, required — Row identifier for AG Grid merging
    - `id` integer, required — Row identifier for AG Grid getRowId
  - `engine_used` 'postgres', required — * `postgres` - postgres
  - `pivot_result_fields` string[] — Sorted list of pivot column names
  - `totals_row` object — Grand totals across all rows
  - `pivot_value_mappings` object — Mapping of pivot field -> {display_name: id} for drilldown

---

[API](https://skmtc.net/campfire/apis/campfire-developer-apis.md) · [All operations](https://skmtc.net/campfire/apis/campfire-developer-apis/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/campfire/campfire-developer-apis/versions/6945ebc3180e/schema)