<!-- Generated by scripts/generate_endpoint_docs.py — do not edit by hand. -->
# `api.reports.sales_summary`

> `POST /reports/sales/summary` — ACPortal

**Python**

```python
api.reports.sales_summary(*, data: SalesForecastSummaryRequest | dict) -> SalesForecastSummary
```

**CLI**

```bash
ab reports sales_summary [--data ...]
```

POST /reports/sales/summary.

Args:
    data: Sales forecast summary payload with date range filters.
        Accepts a :class:`SalesForecastSummaryRequest` instance
        or a dict.

Request model: :class:`SalesForecastSummaryRequest`

## Request body — `SalesForecastSummaryRequest`

| Field | Type | Required | Description |
|---|---|---|---|
| `startDate` | `Optional[str]` | no | Range start date (ISO 8601) |
| `endDate` | `Optional[str]` | no | Range end date (ISO 8601) |

## Response

Returns `SalesForecastSummary`.

| Field | Type | Required | Description |
|---|---|---|---|
| `revenue` | `Optional[float]` | no | Total revenue |
| `profit` | `Optional[float]` | no | Total profit |
| `grossMargin` | `Optional[float]` | no | Gross margin percentage |
| `closeRatio` | `Optional[float]` | no | Close ratio |

---

[← Back to api.reports](../reports.md)