Dokumentacja API

Payrolls API

CRUD list płac pracowników.

GET /api/v1/payrolls
POST /api/v1/payrolls
GET /api/v1/payrolls/{id}
PATCH /api/v1/payrolls/{id}
DELETE /api/v1/payrolls/{id}

200 201 401 422 500

Nagłówki

Accept: application/json
Content-Type: application/json
Authorization: Bearer {token}

Wszystkie endpointy tej sekcji działają pod middleware auth:sanctum.

Pola request body

Pole Typ Wymagane przy POST Opis
employee_id integer tak ID pracownika.
period_year integer tak Rok okresu płacowego.
period_month integer tak Miesiąc od 1 do 12.
gross_amount/net_amount decimal tak Kwoty brutto i netto.
status enum tak to_pay albo paid.

Przy PATCH można wysłać tylko pola, które mają zostać zmienione.

Filtry listy

Endpoint listy przyjmuje query string z filtrami:

employee_id={wartosc}
period_year={wartosc}
period_month={wartosc}
status={wartosc}
created_by_user_id={wartosc}
per_page=25

Jeżeli per_page nie zostanie podane, API zwróci pełną kolekcję.

Przykładowy request

{
    "employee_id": 1,
    "period_year": 2026,
    "period_month": 3,
    "gross_amount": 10000,
    "net_amount": 7200,
    "payout_date": "2026-03-31",
    "status": "to_pay",
    "created_by_user_id": 1
}

Przykładowa odpowiedź

{
  "data": {
    "id": 1,
    "...": "pola zasobu",
    "created_at": "2026-07-21T10:00:00.000000Z",
    "updated_at": "2026-07-21T10:00:00.000000Z"
  }
}

Live test