---
title: "Replace the excluded-bucket set for one scope (\"clinic\" or a single \"vet\"). Requires user_management since it changes how production pay is reported."
method: PUT
path: "/Metrics/compensation-exclusions"
tags: ["Metrics"]
---

# Replace the excluded-bucket set for one scope ("clinic" or a single "vet"). Requires user_management since it changes how production pay is reported.

`PUT /Metrics/compensation-exclusions`

## Request

- Base URL: `https://api.clinicos.vet/backend/business`
- URL: `https://api.clinicos.vet/backend/business/Metrics/compensation-exclusions`
- Auth: HTTP bearer
- TypeScript: <https://skmtc.dev/clinicos/apis/pawthosx-business-api-v1/docs/Metrics/compensation-exclusions/put.ts> (a function with typed inputs; its response is checked against the schema)

## Request body

- UpsertCompensationExclusionDto: Replaces the full bucket set for a single scope ("clinic" or one "vet").
  - `scope` string: "clinic" or "vet".
  - `scopeId` string, nullable: Required when string UpsertCompensationExclusionDto.Scope is "vet": the provider's user id.
  - `buckets` string[]

## Response `200`

OK

- BusinessMetricsResponseDtoOfCompensationExclusionsDto
  - `success` boolean
  - `data` CompensationExclusionsDto: Service-mix buckets excluded from production-pay revenue. Clinic-wide buckets apply to every provider; per-provider buckets are additive on top of the clinic-wide set.
    - `clinic` string[]
    - `providers` ProviderExclusionsDto[]
      - `userId` string
      - `name` string
      - `buckets` string[]
  - `error` string, nullable
  - `message` string, nullable

## Other responses

- `400`: Bad Request

---

[API](https://skmtc.dev/clinicos/apis/pawthosx-business-api-v1.md) - [All operations](https://skmtc.dev/clinicos/apis/pawthosx-business-api-v1/llms.txt) - [OpenAPI document](https://skmtc.dev/clinicos/apis/pawthosx-business-api-v1/revisions/099cf36186e0?raw)