PayrollRun

Create a payroll run

POST

http://localhost:3000/api/payroll-run

curl -X POST 'http://localhost:3000/api/payroll-run' \
  -H 'Content-Type: application/json' \
  --data-raw '{
  "tenant": {},
  "tenantId": "string",
  "organization": {},
  "organizationId": "string",
  "sentTo": "string",
  "periodStart": "2024-01-15T09:30:00Z",
  "periodEnd": "2024-01-15T09:30:00Z",
  "payDate": "2024-01-15T09:30:00Z",
  "frequency": "WEEKLY",
  "currency": "string",
  "notes": "string"
}'

const body = `{
  "tenant": {},
  "tenantId": "string",
  "organization": {},
  "organizationId": "string",
  "sentTo": "string",
  "periodStart": "2024-01-15T09:30:00Z",
  "periodEnd": "2024-01-15T09:30:00Z",
  "payDate": "2024-01-15T09:30:00Z",
  "frequency": "WEEKLY",
  "currency": "string",
  "notes": "string"
}`;

const response = await fetch('http://localhost:3000/api/payroll-run', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
  },
  body,
});

const data = await response.text();

import requests

body = '''{
  "tenant": {},
  "tenantId": "string",
  "organization": {},
  "organizationId": "string",
  "sentTo": "string",
  "periodStart": "2024-01-15T09:30:00Z",
  "periodEnd": "2024-01-15T09:30:00Z",
  "payDate": "2024-01-15T09:30:00Z",
  "frequency": "WEEKLY",
  "currency": "string",
  "notes": "string"
}'''

response = requests.post(
    'http://localhost:3000/api/payroll-run',
    data=body.encode('utf-8'),
    headers={
        'Content-Type': 'application/json',
    },
)
print(response.text)

Request Body

{
  "tenant": {},
  "tenantId": "string",
  "organization": {},
  "organizationId": "string",
  "sentTo": "string",
  "periodStart": "2024-01-15T09:30:00Z",
  "periodEnd": "2024-01-15T09:30:00Z",
  "payDate": "2024-01-15T09:30:00Z",
  "frequency": "WEEKLY",
  "currency": "string",
  "notes": "string"
}

Body

application/json

tenantobject

tenantIdstring

organizationobjectrequired

organizationIdstringrequired

sentTostring

periodStartstring<date-time>required

periodEndstring<date-time>required

payDatestring<date-time>required

frequencystringWEEKLYBI_WEEKLYSEMI_MONTHLYMONTHLYQUARTERLYANNUALLYrequired

currencystringrequired

notesstring

Response

201Created

The payroll run has been created.

400Bad Request

Invalid input, check the response body for details

Stack Overflow Website Demo