---
title: "The partner's settled periods + current unsettled wholesale exposure vs ceiling."
method: POST
path: "/v1/partner/settlement/summary"
tags: ["resource-facade"]
---

# The partner's settled periods + current unsettled wholesale exposure vs ceiling.

`POST /v1/partner/settlement/summary`

## Headers

- `x-api-key` string, nullable

## Request body

- PartnerSettlementSummaryInput

## Response `200`

Successful Response

- PartnerSettlementSummaryOutput
  - `brand_id` string, required
  - `settlements` SettledPeriod[], required
    - `id` string, required
    - `period_start` string, required
    - `period_end` string, required
    - `wholesale_total` number, required
    - `retail_total` number, required
    - `order_count` integer, required
    - `xero_ref` string, nullable
    - `settled_at` string, nullable
  - `unsettled_wholesale_aud` number, required
  - `outstanding_credits` integer, required
  - `exposure_ceiling_credits` integer, nullable
  - `remaining_credits` integer, nullable

## Other responses

- `401` — Unauthorized
- `403` — Forbidden
- `404` — Not Found
- `422` — Validation Error
- `500` — Internal Server Error

---

[API](https://skmtc.dev/geopera/apis/geopera-data-platform.md) · [All operations](https://skmtc.dev/geopera/apis/geopera-data-platform/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/geopera/geopera-data-platform/revisions/cb0130b2a40a/schema)