Administration5

Calendars9

Case fields6

Case relations7

Cases7

Collectors7

Company case changes5

Company case documents3

Company case values4

Divisions9

Employee case changes5

Employee case documents3

Employee case values4

Employees10

Global case changes5

Global case documents3

Global case values4

Logs5

Lookup values7

Lookups10

National case changes5

National case documents3

National case values4

Payroll consolidated results5

Payroll layers9

Payroll results11

Payrolls33

Payrun jobs13

Payrun parameters6

Payruns7

Regulations10

Report logs5

Report parameters6

Report templates6

Reports14

Scripts6

Tasks9

Tenants13

Users11

Wage types7

Webhook messages6

Webhooks9

Payrun jobs

POST /api/tenants/{tenantId}/payruns/jobs

Changed on Apr 1, 2026

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/jobs/post.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

tenantIdinteger required

Request body

idinteger

status'Active' | 'Inactive'

createdstring date-time

updatedstring date-time

payrunNamestring required

userIdentifierstring required

payrunJobIdinteger

parentJobIdinteger nullable

namestring required

ownerstring nullable

tagsstring[] nullable

forecaststring nullable

retroPayMode'ValueChange' | 'None'

jobResult'Full' | 'Incremental'

periodStartstring date-time required

evaluationDatestring date-time nullable

reasonstring required

storeEmptyResultsboolean

employeeIdentifiersstring[] nullable

attributesobject nullable

Response

Accepted

Changes

Apr 1, 202634e260deaa2c Revision changes
- info
  added the new optional request property (media type: application/json)
- info
  added the new optional request property (media type: text/json)
- info
  added the new optional request property (media type: application/*+json)
Mar 9, 202697ae205209e8 Revision changes
- breaking
  added the new required request property (media type: application/json)
- breaking
  added the new required request property (media type: text/json)
- breaking
  added the new required request property (media type: application/*+json)
- breaking
  added the new required request property (media type: application/json)
- breaking
  added the new required request property (media type: text/json)
- breaking
  added the new required request property (media type: application/*+json)
- warning
  removed the request property (media type: application/json)
- warning
  removed the request property (media type: text/json)
- warning
  removed the request property (media type: application/*+json)
- warning
  removed the request property (media type: application/json)
- warning
  removed the request property (media type: text/json)
- warning
  removed the request property (media type: application/*+json)
- info
  added the non-success response with the status
- info
  added the non-success response with the status

Operation history (6 revisions)