---
title: "PUT /api/tenants/{tenantId}/payrolls/{payrollId}"
method: PUT
path: "/api/tenants/{tenantId}/payrolls/{payrollId}"
tags: ["Payrolls"]
---

# PUT /api/tenants/{tenantId}/payrolls/{payrollId}

`PUT /api/tenants/{tenantId}/payrolls/{payrollId}`

## Path parameters

- `tenantId` integer, required
- `payrollId` string, required

## Request body

- Payroll
  - `id` integer
  - `status` 'Active' | 'Inactive'
  - `created` string, date-time
  - `updated` string, date-time
  - `name` string, required
  - `nameLocalizations` object, nullable
  - `description` string, nullable
  - `descriptionLocalizations` object, nullable
  - `divisionId` integer, required
  - `clusterSetCase` string, nullable
  - `clusterSetCaseField` string, nullable
  - `clusterSetCollector` string, nullable
  - `clusterSetCollectorRetro` string, nullable
  - `clusterSetWageType` string, nullable
  - `clusterSetWageTypeRetro` string, nullable
  - `clusterSetCaseValue` string, nullable
  - `clusterSetWageTypePeriod` string, nullable
  - `clusterSets` ClusterSet[], nullable
    - `name` string, nullable
    - `includeClusters` string[], nullable
    - `excludeClusters` string[], nullable
  - `attributes` object, nullable

## Response `200`

OK

- Payroll
  - `id` integer
  - `status` 'Active' | 'Inactive'
  - `created` string, date-time
  - `updated` string, date-time
  - `name` string, required
  - `nameLocalizations` object, nullable
  - `description` string, nullable
  - `descriptionLocalizations` object, nullable
  - `divisionId` integer, required
  - `clusterSetCase` string, nullable
  - `clusterSetCaseField` string, nullable
  - `clusterSetCollector` string, nullable
  - `clusterSetCollectorRetro` string, nullable
  - `clusterSetWageType` string, nullable
  - `clusterSetWageTypeRetro` string, nullable
  - `clusterSetCaseValue` string, nullable
  - `clusterSetWageTypePeriod` string, nullable
  - `clusterSets` ClusterSet[], nullable
    - `name` string, nullable
    - `includeClusters` string[], nullable
    - `excludeClusters` string[], nullable
  - `attributes` object, nullable

## Other responses

- `404` — Not Found
- `422` — Unprocessable Content

---

[API](https://skmtc.net/payroll-engine/apis/payroll-engine-backend-api-v1.md) · [All operations](https://skmtc.net/payroll-engine/apis/payroll-engine-backend-api-v1/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/payroll-engine/payroll-engine-backend-api-v1/versions/34e260deaa2c/schema)