---
title: "PUT /api/tenants/{tenantId}/payruns/{payrunId}"
method: PUT
path: "/api/tenants/{tenantId}/payruns/{payrunId}"
tags: ["Payruns"]
---

# PUT /api/tenants/{tenantId}/payruns/{payrunId}

`PUT /api/tenants/{tenantId}/payruns/{payrunId}`

## Request

- The document declares no server URL.
- Auth: none declared
- TypeScript: <https://skmtc.dev/payroll-engine/apis/payroll-engine-backend-api-v1/docs/api/tenants/:tenantId/payruns/:payrunId/put.ts> (a function with typed inputs; its response is checked against the schema)

## Path parameters

- `tenantId` integer, required
- `payrunId` string, required

## Request body

- Payrun
  - `id` integer
  - `status` 'Active' | 'Inactive'
  - `created` string, date-time
  - `updated` string, date-time
  - `payrollId` integer
  - `name` string, required
  - `nameLocalizations` object, nullable
  - `defaultReason` string, nullable
  - `defaultReasonLocalizations` object, nullable
  - `startExpression` string, nullable
  - `employeeAvailableExpression` string, nullable
  - `employeeStartExpression` string, nullable
  - `employeeEndExpression` string, nullable
  - `wageTypeAvailableExpression` string, nullable
  - `endExpression` string, nullable
  - `retroBackCycles` integer

## Response `200`

OK

- Payrun
  - `id` integer
  - `status` 'Active' | 'Inactive'
  - `created` string, date-time
  - `updated` string, date-time
  - `payrollId` integer
  - `name` string, required
  - `nameLocalizations` object, nullable
  - `defaultReason` string, nullable
  - `defaultReasonLocalizations` object, nullable
  - `startExpression` string, nullable
  - `employeeAvailableExpression` string, nullable
  - `employeeStartExpression` string, nullable
  - `employeeEndExpression` string, nullable
  - `wageTypeAvailableExpression` string, nullable
  - `endExpression` string, nullable
  - `retroBackCycles` integer

## Other responses

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

## Changes

- **2026-04-01** `34e260deaa2c`: 4 warning, 4 info
  - removed the request property `retroTimeType` (media type: application/json)
  - removed the request property `retroTimeType` (media type: text/json)
  - removed the request property `retroTimeType` (media type: application/*+json)
  - removed the optional property `retroTimeType` from the response with the `200` status
  - …4 more
- **2026-03-09** `642427b60b7a`: 76 warning
  - added the new `8192.00` enum value to the `additionalProperties/errors/items/exception/targetSite/customAttributes/items/constructor/methodImplementationFlags` response property for the response status `422`
  - added the new `8192.00` enum value to the `additionalProperties/errors/items/exception/targetSite/customAttributes/items/constructor/module/assembly/definedTypes/items/declaredEvents/items/addMethod/methodImplementationFlags` response property for the response status `422`
  - added the new `8192.00` enum value to the `additionalProperties/errors/items/exception/targetSite/customAttributes/items/constructor/module/assembly/definedTypes/items/declaredEvents/items/raiseMethod/methodImplementationFlags` response property for the response status `422`
  - added the new `8192.00` enum value to the `additionalProperties/errors/items/exception/targetSite/customAttributes/items/constructor/module/assembly/definedTypes/items/declaredEvents/items/removeMethod/methodImplementationFlags` response property for the response status `422`
  - …72 more
- …earlier changes not shown

[Operation history](https://skmtc.dev/payroll-engine/apis/payroll-engine-backend-api-v1/changes/api/tenants/:tenantId/payruns/:payrunId/put.md)

---

[API](https://skmtc.dev/payroll-engine/apis/payroll-engine-backend-api-v1.md) - [All operations](https://skmtc.dev/payroll-engine/apis/payroll-engine-backend-api-v1/llms.txt) - [OpenAPI document](https://skmtc.dev/payroll-engine/apis/payroll-engine-backend-api-v1/revisions/7e8994a2c5bb?raw)