Generate payroll

Develop Env

https://dev.your-api-server.com

POST

/payrolls

Asynchronously generate payroll for given period.
Returns immediately with job_id. Check status via /jobs/{job_id}.
Requires Idempotency-Key header.

Request

Authorization

JWT Bearer

Add the parameter

Authorization

to Headers

Example:

Authorization: ********************

Header Params

Body Params application/jsonRequired

Example

{
    "period_year": 2025,
    "period_month": 11,
    "department_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "employee_ids": [
        "3fa85f64-5717-4562-b3fc-2c963f66afa6"
    ]
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://dev.your-api-server.com/payrolls' \
--header 'Idempotency-Key;' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "period_year": 2025,
    "period_month": 11,
    "department_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "employee_ids": [
        "3fa85f64-5717-4562-b3fc-2c963f66afa6"
    ]
}'

Responses

🟢202Accepted

application/json

Payroll generation accepted

Headers

Body

Example

{
    "job_id": "job_payroll_nov2025",
    "status": "queued",
    "progress": {
        "processed": 15,
        "total": 100
    },
    "result": {
        "payroll_ids": [
            "497f6eca-6276-4993-bfeb-53cbbbba6f08"
        ]
    },
    "error": null,
    "created_at": "2025-11-13T09:00:00Z",
    "updated_at": "2025-11-13T09:05:00Z"
}

🟠400Bad Request

🟠401Unauthorized

🟠403Forbidden

🟠409Conflict

Modified at 2025-11-17 05:13:15

Update salary component

Check job status