Raqm solutions · Developers

Raqm HR API documentation

Every endpoint is read from this project, including its HTTP method, access requirement, and parameters declared by the route and request validation.

228live endpoints

Before you start

Base URLhttps://raqm-hr.com/api

AuthorizationBearer token for protected routes

Data formatJSON / multipart when uploading a file

Never expose access tokens or real employee data in browser JavaScript. Request secure integration credentials from the Raqm team.

Attendance devices

6 routes

GET /api/biometric/cdataBiometricController · push Public

GEThttps://raqm-hr.com/api/biometric/cdata

Controller: BiometricController · pushRoute name: api.biometric.cdata.get

Parameters

NameInRequiredValidation / source

device_idBodyYesrequired

recordsBodyYesrequired|array

statusBodyNosuccess

SNQueryNoRead from query string

snQueryNoRead from query string

tableQueryNoRead from query string

TableQueryNoRead from query string

Example request

curl --request GET 'https://raqm-hr.com/api/biometric/cdata?SN=VALUE&sn=VALUE&table=VALUE&Table=VALUE' \
  --header 'Accept: application/json'

Replace VALUE and :id with real values. The response varies by your account data and permissions.

POST /api/biometric/cdataBiometricController · push Public

POSThttps://raqm-hr.com/api/biometric/cdata

Controller: BiometricController · pushRoute name: api.biometric.cdata

Parameters

NameInRequiredValidation / source

device_idBodyYesrequired

recordsBodyYesrequired|array

statusBodyNosuccess

SNQueryNoRead from query string

snQueryNoRead from query string

tableQueryNoRead from query string

TableQueryNoRead from query string

Example request

curl --request POST 'https://raqm-hr.com/api/biometric/cdata?SN=VALUE&sn=VALUE&table=VALUE&Table=VALUE' \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{
    "device_id": "VALUE",
    "records": "VALUE",
    "status": "VALUE"
}'

Replace VALUE and :id with real values. The response varies by your account data and permissions.

POST /api/biometric/devicecmdBiometricController · devicecmd Public

POSThttps://raqm-hr.com/api/biometric/devicecmd

Controller: BiometricController · devicecmdRoute name: api.biometric.devicecmd

Parameters

No parameters are declared by this route or its request validation.

Example request

curl --request POST 'https://raqm-hr.com/api/biometric/devicecmd' \
  --header 'Accept: application/json'

Replace VALUE and :id with real values. The response varies by your account data and permissions.

GET /api/biometric/getrequestBiometricController · getrequest Public

GEThttps://raqm-hr.com/api/biometric/getrequest

Controller: BiometricController · getrequestRoute name: api.biometric.getrequest

Parameters

No parameters are declared by this route or its request validation.

Example request

curl --request GET 'https://raqm-hr.com/api/biometric/getrequest' \
  --header 'Accept: application/json'

Replace VALUE and :id with real values. The response varies by your account data and permissions.

GET /api/biometric/handshakeBiometricController · handshake Public

GEThttps://raqm-hr.com/api/biometric/handshake

Controller: BiometricController · handshakeRoute name: api.biometric.handshake

Parameters

NameInRequiredValidation / source

statusBodyNosuccess

messageBodyNoConnection established

Example request

curl --request GET 'https://raqm-hr.com/api/biometric/handshake' \
  --header 'Accept: application/json'

Replace VALUE and :id with real values. The response varies by your account data and permissions.

POST /api/biometric/pushBiometricController · push Public

POSThttps://raqm-hr.com/api/biometric/push

Controller: BiometricController · pushRoute name: api.biometric.push

Parameters

NameInRequiredValidation / source

device_idBodyYesrequired

recordsBodyYesrequired|array

statusBodyNosuccess

SNQueryNoRead from query string

snQueryNoRead from query string

tableQueryNoRead from query string

TableQueryNoRead from query string

Example request

curl --request POST 'https://raqm-hr.com/api/biometric/push?SN=VALUE&sn=VALUE&table=VALUE&Table=VALUE' \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{
    "device_id": "VALUE",
    "records": "VALUE",
    "status": "VALUE"
}'

Replace VALUE and :id with real values. The response varies by your account data and permissions.

Employee mobile API

182 routes

POST /api/employee/absence-penalty/early-leaveAbsencePenaltyController · earlyLeave Bearer Subscription

POSThttps://raqm-hr.com/api/employee/absence-penalty/early-leave

Controller: AbsencePenaltyController · earlyLeave

Parameters

NameInRequiredValidation / source

dateBodyNonullable|date

Example request

curl --request POST 'https://raqm-hr.com/api/employee/absence-penalty/early-leave' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
    "date": "YYYY-MM-DD"
}'

Replace VALUE and :id with real values. The response varies by your account data and permissions.

POST /api/employee/absence-penalty/processAbsencePenaltyController · process Bearer Subscription

POSThttps://raqm-hr.com/api/employee/absence-penalty/process

Controller: AbsencePenaltyController · process

Parameters

NameInRequiredValidation / source

dateBodyNonullable|date

Example request

curl --request POST 'https://raqm-hr.com/api/employee/absence-penalty/process' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
    "date": "YYYY-MM-DD"
}'

Replace VALUE and :id with real values. The response varies by your account data and permissions.

GET /api/employee/absence-penalty/statusAbsencePenaltyController · status Bearer Subscription

GEThttps://raqm-hr.com/api/employee/absence-penalty/status

Controller: AbsencePenaltyController · status

Parameters

No parameters are declared by this route or its request validation.

Example request

curl --request GET 'https://raqm-hr.com/api/employee/absence-penalty/status' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN'

Replace VALUE and :id with real values. The response varies by your account data and permissions.

GET /api/employee/approvalsApprovalsController · index Bearer Subscription

GEThttps://raqm-hr.com/api/employee/approvals

Controller: ApprovalsController · index

Parameters

No parameters are declared by this route or its request validation.

Example request

curl --request GET 'https://raqm-hr.com/api/employee/approvals' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN'

Replace VALUE and :id with real values. The response varies by your account data and permissions.

GET /api/employee/approvals/historyApprovalsController · history Bearer Subscription

GEThttps://raqm-hr.com/api/employee/approvals/history

Controller: ApprovalsController · history

Parameters

No parameters are declared by this route or its request validation.

Example request

curl --request GET 'https://raqm-hr.com/api/employee/approvals/history' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN'

Replace VALUE and :id with real values. The response varies by your account data and permissions.

GET /api/employee/approvals/{id}RequestsController · show Bearer Subscription

GEThttps://raqm-hr.com/api/employee/approvals/{id}

Controller: RequestsController · show

Parameters

NameInRequiredValidation / source

idPathYesRoute parameter

Example request

curl --request GET 'https://raqm-hr.com/api/employee/approvals/:id' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN'

Replace VALUE and :id with real values. The response varies by your account data and permissions.

POST /api/employee/approvals/{id}/actionRequestsController · processAction Bearer Subscription

POSThttps://raqm-hr.com/api/employee/approvals/{id}/action

Controller: RequestsController · processAction

Parameters

NameInRequiredValidation / source

idPathYesRoute parameter

Example request

curl --request POST 'https://raqm-hr.com/api/employee/approvals/:id/action' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN'

Replace VALUE and :id with real values. The response varies by your account data and permissions.

POST /api/employee/approvals/{id}/approveRequestsController · processAction Bearer Subscription

POSThttps://raqm-hr.com/api/employee/approvals/{id}/approve

Controller: RequestsController · processAction

Parameters

NameInRequiredValidation / source

idPathYesRoute parameter

Example request

curl --request POST 'https://raqm-hr.com/api/employee/approvals/:id/approve' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN'

Replace VALUE and :id with real values. The response varies by your account data and permissions.

POST /api/employee/approvals/{id}/processApprovalsController · process Bearer Subscription

POSThttps://raqm-hr.com/api/employee/approvals/{id}/process

Controller: ApprovalsController · process

Parameters

NameInRequiredValidation / source

idPathYesRoute parameter

statusBodyYesrequired|in:approved,rejected

commentsBodyNonullable|string

Example request

curl --request POST 'https://raqm-hr.com/api/employee/approvals/:id/process' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
    "status": "VALUE",
    "comments": "VALUE"
}'

Replace VALUE and :id with real values. The response varies by your account data and permissions.

POST /api/employee/approvals/{id}/rejectRequestsController · processAction Bearer Subscription

POSThttps://raqm-hr.com/api/employee/approvals/{id}/reject

Controller: RequestsController · processAction

Parameters

NameInRequiredValidation / source

idPathYesRoute parameter

Example request

curl --request POST 'https://raqm-hr.com/api/employee/approvals/:id/reject' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN'

Replace VALUE and :id with real values. The response varies by your account data and permissions.

POST /api/employee/attendance/checkinAttendanceController · checkIn Bearer Subscription

POSThttps://raqm-hr.com/api/employee/attendance/checkin

Controller: AttendanceController · checkIn

Parameters

NameInRequiredValidation / source

statusBodyNopresent

typeBodyNocheck_in

messageBodyNoChecked in successfully

Example request

curl --request POST 'https://raqm-hr.com/api/employee/attendance/checkin' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
    "status": "VALUE",
    "type": "VALUE",
    "message": "VALUE"
}'

Replace VALUE and :id with real values. The response varies by your account data and permissions.

POST /api/employee/attendance/checkoutAttendanceController · checkOut Bearer Subscription

POSThttps://raqm-hr.com/api/employee/attendance/checkout

Controller: AttendanceController · checkOut

Parameters

NameInRequiredValidation / source

typeBodyNocheck_out

messageBodyNoChecked out successfully

Example request

curl --request POST 'https://raqm-hr.com/api/employee/attendance/checkout' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
    "type": "VALUE",
    "message": "VALUE"
}'

Replace VALUE and :id with real values. The response varies by your account data and permissions.

GET /api/employee/attendance/historyAttendanceController · history Bearer Subscription

GEThttps://raqm-hr.com/api/employee/attendance/history

Controller: AttendanceController · history

Parameters

No parameters are declared by this route or its request validation.

Example request

curl --request GET 'https://raqm-hr.com/api/employee/attendance/history' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN'

Replace VALUE and :id with real values. The response varies by your account data and permissions.

GET /api/employee/attendance/locationsAttendanceController · locations Bearer Subscription

GEThttps://raqm-hr.com/api/employee/attendance/locations

Controller: AttendanceController · locations

Parameters

No parameters are declared by this route or its request validation.

Example request

curl --request GET 'https://raqm-hr.com/api/employee/attendance/locations' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN'

Replace VALUE and :id with real values. The response varies by your account data and permissions.

GET /api/employee/attendance/summaryAttendanceController · monthlySummary Bearer Subscription

GEThttps://raqm-hr.com/api/employee/attendance/summary

Controller: AttendanceController · monthlySummary

Parameters

No parameters are declared by this route or its request validation.

Example request

curl --request GET 'https://raqm-hr.com/api/employee/attendance/summary' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN'

Replace VALUE and :id with real values. The response varies by your account data and permissions.

GET /api/employee/calendar/connect/{provider}CalendarConnectionController · authUrl Bearer Subscription

GEThttps://raqm-hr.com/api/employee/calendar/connect/{provider}

Controller: CalendarConnectionController · authUrl

Parameters

NameInRequiredValidation / source

providerPathYesRoute parameter

Example request

curl --request GET 'https://raqm-hr.com/api/employee/calendar/connect/:provider' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN'

Replace VALUE and :id with real values. The response varies by your account data and permissions.

GET /api/employee/calendar/connectionsCalendarConnectionController · index Bearer Subscription

GEThttps://raqm-hr.com/api/employee/calendar/connections

Controller: CalendarConnectionController · index

Parameters

No parameters are declared by this route or its request validation.

Example request

curl --request GET 'https://raqm-hr.com/api/employee/calendar/connections' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN'

Replace VALUE and :id with real values. The response varies by your account data and permissions.

POST /api/employee/calendar/disconnect/{provider}CalendarConnectionController · disconnect Bearer Subscription

POSThttps://raqm-hr.com/api/employee/calendar/disconnect/{provider}

Controller: CalendarConnectionController · disconnect

Parameters

NameInRequiredValidation / source

providerPathYesRoute parameter

Example request

curl --request POST 'https://raqm-hr.com/api/employee/calendar/disconnect/:provider' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN'

Replace VALUE and :id with real values. The response varies by your account data and permissions.

GET /api/employee/calendar/eventsCalendarController · events Bearer Subscription

GEThttps://raqm-hr.com/api/employee/calendar/events

Controller: CalendarController · events

Parameters

NameInRequiredValidation / source

errorBodyNoUnauthenticated

idBodyNoholiday_

titleBodyNo🎉

backgroundColorBodyNo#3b82f6

borderColorBodyNo#2563eb

extendedPropsBodyNotype | holiday | description

displayBodyNobackground

Example request

curl --request GET 'https://raqm-hr.com/api/employee/calendar/events' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN'

Replace VALUE and :id with real values. The response varies by your account data and permissions.

POST /api/employee/calendar/meetingsCalendarController · storeMeeting Bearer Subscription

POSThttps://raqm-hr.com/api/employee/calendar/meetings

Controller: CalendarController · storeMeeting

Parameters

NameInRequiredValidation / source

titleBodyYesrequired|string|max:255

start_timeBodyYesrequired|date

end_timeBodyYesrequired|date|after:start_time

attendeesBodyNonullable|array

typeBodyNomeeting

locationBodyYesnullable|required_if:type,offline

linkBodyYesnullable|required_if:type,online|url

descriptionBodyNonullable|string

team_workspace_idBodyNonullable|exists:team_workspaces,id

is_recurringBodyNonullable|boolean

recurrence_typeBodyYesnullable|required_if:is_recurring,1|in:daily,weekly,biweekly,monthly,yearly

recurrence_intervalBodyNonullable|integer|min:1

recurrence_end_dateBodyNonullable|date|after_or_equal:start_time

errorBodyNoUnauthenticated

statusBodyNopending

errorsBodyNoconflicts

messageBodyNoتم إنشاء الموعد بنجاح وجدولة الاجتماع

Example request

curl --request POST 'https://raqm-hr.com/api/employee/calendar/meetings' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
    "title": "VALUE",
    "start_time": "YYYY-MM-DD",
    "end_time": "YYYY-MM-DD",
    "attendees": "VALUE",
    "type": "VALUE",
    "location": "VALUE",
    "link": "VALUE",
    "description": "VALUE",
    "team_workspace_id": "VALUE",
    "is_recurring": true,
    "recurrence_type": "VALUE",
    "recurrence_interval": 0,
    "recurrence_end_date": "YYYY-MM-DD",
    "error": "VALUE",
    "status": "VALUE",
    "errors": "VALUE",
    "message": "VALUE"
}'

Replace VALUE and :id with real values. The response varies by your account data and permissions.

GET /api/employee/complaintsComplaintsController · index Bearer Subscription

GEThttps://raqm-hr.com/api/employee/complaints

Controller: ComplaintsController · index

Parameters

No parameters are declared by this route or its request validation.

Example request

curl --request GET 'https://raqm-hr.com/api/employee/complaints' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN'

Replace VALUE and :id with real values. The response varies by your account data and permissions.

POST /api/employee/complaintsComplaintsController · store Bearer Subscription

POSThttps://raqm-hr.com/api/employee/complaints

Controller: ComplaintsController · store

Parameters

NameInRequiredValidation / source

subjectBodyYesrequired|string

descriptionBodyYesrequired|string

typeBodyNonullable|string

priorityBodyNonullable|string

against_employee_idBodyNonullable|exists:employees,id

statusBodyNoجديدة

Example request

curl --request POST 'https://raqm-hr.com/api/employee/complaints' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
    "subject": "VALUE",
    "description": "VALUE",
    "type": "VALUE",
    "priority": "VALUE",
    "against_employee_id": "VALUE",
    "status": "VALUE"
}'

Replace VALUE and :id with real values. The response varies by your account data and permissions.

GET /api/employee/countriesCountryController · index Bearer Subscription

GEThttps://raqm-hr.com/api/employee/countries

Controller: CountryController · index

Parameters

No parameters are declared by this route or its request validation.

Example request

curl --request GET 'https://raqm-hr.com/api/employee/countries' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN'

Replace VALUE and :id with real values. The response varies by your account data and permissions.

GET /api/employee/countries/searchCountryController · search Bearer Subscription

GEThttps://raqm-hr.com/api/employee/countries/search

Controller: CountryController · search

Parameters

NameInRequiredValidation / source

qBodyYesrequired|string|min:2

Example request

curl --request GET 'https://raqm-hr.com/api/employee/countries/search' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN'

Replace VALUE and :id with real values. The response varies by your account data and permissions.

GET /api/employee/countries/{id}/citiesCountryController · cities Bearer Subscription

GEThttps://raqm-hr.com/api/employee/countries/{id}/cities

Controller: CountryController · cities

Parameters

NameInRequiredValidation / source

idPathYesRoute parameter

countryBodyNoid | name | name_ar

Example request

curl --request GET 'https://raqm-hr.com/api/employee/countries/:id/cities' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN'

Replace VALUE and :id with real values. The response varies by your account data and permissions.

GET /api/employee/custodyCustodyController · index Bearer Subscription

GEThttps://raqm-hr.com/api/employee/custody

Controller: CustodyController · index

Parameters

No parameters are declared by this route or its request validation.

Example request

curl --request GET 'https://raqm-hr.com/api/employee/custody' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN'

Replace VALUE and :id with real values. The response varies by your account data and permissions.

GET /api/employee/custody/approvedCustodyController · approved Bearer Subscription

GEThttps://raqm-hr.com/api/employee/custody/approved

Controller: CustodyController · approved

Parameters

No parameters are declared by this route or its request validation.

Example request

curl --request GET 'https://raqm-hr.com/api/employee/custody/approved' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN'

Replace VALUE and :id with real values. The response varies by your account data and permissions.

GET /api/employee/dashboardDashboardController · index Bearer Subscription

GEThttps://raqm-hr.com/api/employee/dashboard

Controller: DashboardController · index

Parameters

NameInRequiredValidation / source

attendanceBodyNochecked_in | check_in_time | check_out_time

leavesBodyNoused_days | pending_requests | status | pending

requestsBodyNopending

payrollBodyNocurrent_month | basic_salary | total_earnings | total_deductions | net_salary

localeQueryNoRead from query string

Example request

curl --request GET 'https://raqm-hr.com/api/employee/dashboard?locale=VALUE' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN'

Replace VALUE and :id with real values. The response varies by your account data and permissions.

GET /api/employee/departmentsDepartmentController · index Bearer Subscription

GEThttps://raqm-hr.com/api/employee/departments

Controller: DepartmentController · index

Parameters

No parameters are declared by this route or its request validation.

Example request

curl --request GET 'https://raqm-hr.com/api/employee/departments' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN'

Replace VALUE and :id with real values. The response varies by your account data and permissions.

POST /api/employee/device/resetAuthController · resetDevice Public

POSThttps://raqm-hr.com/api/employee/device/reset

Controller: AuthController · resetDevice

Parameters

NameInRequiredValidation / source

employee_numberBodyYesrequired|string

passwordBodyYesrequired|string

new_device_idBodyYesrequired|string

company_idBodyNonullable|integer

company_emailBodyNonullable|string

companyBodyNonullable|string

errorBodyNoambiguous_employee_number

eventBodyNodevice_reset_self

detailsBodyNoold_device_id | new_device_id | new_device_id

Example request

curl --request POST 'https://raqm-hr.com/api/employee/device/reset' \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{
    "employee_number": "VALUE",
    "password": "VALUE",
    "new_device_id": "VALUE",
    "company_id": 0,
    "company_email": "VALUE",
    "company": "VALUE",
    "error": "VALUE",
    "event": "VALUE",
    "details": "VALUE"
}'

Replace VALUE and :id with real values. The response varies by your account data and permissions.

POST /api/employee/device/reset-requestAuthController · requestDeviceReset Public

POSThttps://raqm-hr.com/api/employee/device/reset-request

Controller: AuthController · requestDeviceReset

Parameters

NameInRequiredValidation / source

employee_numberBodyYesrequired|string

reasonBodyYesrequired|string

company_idBodyNonullable|integer

company_emailBodyNonullable|string

companyBodyNonullable|string

errorBodyNoambiguous_employee_number

eventBodyNodevice_reset_requested

detailsBodyNoreason | reason

Example request

curl --request POST 'https://raqm-hr.com/api/employee/device/reset-request' \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{
    "employee_number": "VALUE",
    "reason": "VALUE",
    "company_id": 0,
    "company_email": "VALUE",
    "company": "VALUE",
    "error": "VALUE",
    "event": "VALUE",
    "details": "VALUE"
}'

Replace VALUE and :id with real values. The response varies by your account data and permissions.

POST /api/employee/device/validateAuthController · validateDevice Bearer Subscription

POSThttps://raqm-hr.com/api/employee/device/validate

Controller: AuthController · validateDevice

Parameters

NameInRequiredValidation / source

device_idBodyYesrequired|string

Example request

curl --request POST 'https://raqm-hr.com/api/employee/device/validate' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
    "device_id": "VALUE"
}'

Replace VALUE and :id with real values. The response varies by your account data and permissions.

GET /api/employee/devicesAuthController · listDevices Bearer Subscription

GEThttps://raqm-hr.com/api/employee/devices

Controller: AuthController · listDevices

Parameters

No parameters are declared by this route or its request validation.

Example request

curl --request GET 'https://raqm-hr.com/api/employee/devices' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN'

Replace VALUE and :id with real values. The response varies by your account data and permissions.

POST /api/employee/devices/revokeAuthController · revokeDevice Bearer Subscription

POSThttps://raqm-hr.com/api/employee/devices/revoke

Controller: AuthController · revokeDevice

Parameters

NameInRequiredValidation / source

device_idBodyYesrequired|integer

Example request

curl --request POST 'https://raqm-hr.com/api/employee/devices/revoke' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
    "device_id": 0
}'

Replace VALUE and :id with real values. The response varies by your account data and permissions.

POST /api/employee/devices/revoke-and-loginAuthController · revokeDeviceAndLogin Public

POSThttps://raqm-hr.com/api/employee/devices/revoke-and-login

Controller: AuthController · revokeDeviceAndLogin

Parameters

NameInRequiredValidation / source

pending_login_tokenBodyYesrequired|string

device_id_to_revokeBodyYesrequired|integer

Example request

curl --request POST 'https://raqm-hr.com/api/employee/devices/revoke-and-login' \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{
    "pending_login_token": "VALUE",
    "device_id_to_revoke": 0
}'

Replace VALUE and :id with real values. The response varies by your account data and permissions.

GET /api/employee/directoryDirectoryController · index Bearer Subscription

GEThttps://raqm-hr.com/api/employee/directory

Controller: DirectoryController · index

Parameters

No parameters are declared by this route or its request validation.

Example request

curl --request GET 'https://raqm-hr.com/api/employee/directory' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN'

Replace VALUE and :id with real values. The response varies by your account data and permissions.

GET /api/employee/directory/searchDirectoryController · search Bearer Subscription

GEThttps://raqm-hr.com/api/employee/directory/search

Controller: DirectoryController · search

Parameters

No parameters are declared by this route or its request validation.

Example request

curl --request GET 'https://raqm-hr.com/api/employee/directory/search' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN'

Replace VALUE and :id with real values. The response varies by your account data and permissions.

GET /api/employee/directory/{id}DirectoryController · show Bearer Subscription

GEThttps://raqm-hr.com/api/employee/directory/{id}

Controller: DirectoryController · show

Parameters

NameInRequiredValidation / source

idPathYesRoute parameter

Example request

curl --request GET 'https://raqm-hr.com/api/employee/directory/:id' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN'

Replace VALUE and :id with real values. The response varies by your account data and permissions.

GET /api/employee/documentsDocumentsController · index Bearer Subscription

GEThttps://raqm-hr.com/api/employee/documents

Controller: DocumentsController · index

Parameters

No parameters are declared by this route or its request validation.

Example request

curl --request GET 'https://raqm-hr.com/api/employee/documents' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN'

Replace VALUE and :id with real values. The response varies by your account data and permissions.

POST /api/employee/documentsDocumentsController · store Bearer Subscription

POSThttps://raqm-hr.com/api/employee/documents

Controller: DocumentsController · store

Parameters

NameInRequiredValidation / source

fileBodyYesrequired|file|max:10240

document_typeBodyYesrequired|string|max:255

end_dateBodyNonullable|date

notesBodyNonullable|string

Example request

curl --request POST 'https://raqm-hr.com/api/employee/documents' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
    "file": "VALUE",
    "document_type": "VALUE",
    "end_date": "YYYY-MM-DD",
    "notes": "VALUE"
}'

Replace VALUE and :id with real values. The response varies by your account data and permissions.

GET /api/employee/experienceProfileController · getExperience Bearer Subscription

GEThttps://raqm-hr.com/api/employee/experience

Controller: ProfileController · getExperience

Parameters

No parameters are declared by this route or its request validation.

Example request

curl --request GET 'https://raqm-hr.com/api/employee/experience' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN'

Replace VALUE and :id with real values. The response varies by your account data and permissions.

GET /api/employee/financesFinancesController · index Bearer Subscription

GEThttps://raqm-hr.com/api/employee/finances

Controller: FinancesController · index

Parameters

No parameters are declared by this route or its request validation.

Example request

curl --request GET 'https://raqm-hr.com/api/employee/finances' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN'

Replace VALUE and :id with real values. The response varies by your account data and permissions.

GET /api/employee/finances/summaryFinancesController · summary Bearer Subscription

GEThttps://raqm-hr.com/api/employee/finances/summary

Controller: FinancesController · summary

Parameters

No parameters are declared by this route or its request validation.

Example request

curl --request GET 'https://raqm-hr.com/api/employee/finances/summary' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN'

Replace VALUE and :id with real values. The response varies by your account data and permissions.

GET /api/employee/gosiGosiController · index Bearer Subscription

GEThttps://raqm-hr.com/api/employee/gosi

Controller: GosiController · index

Parameters

No parameters are declared by this route or its request validation.

Example request

curl --request GET 'https://raqm-hr.com/api/employee/gosi' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN'

Replace VALUE and :id with real values. The response varies by your account data and permissions.

GET /api/employee/insuranceInsuranceController · index Bearer Subscription

GEThttps://raqm-hr.com/api/employee/insurance

Controller: InsuranceController · index

Parameters

No parameters are declared by this route or its request validation.

Example request

curl --request GET 'https://raqm-hr.com/api/employee/insurance' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN'

Replace VALUE and :id with real values. The response varies by your account data and permissions.

GET /api/employee/insurance/historyInsuranceController · history Bearer Subscription

GEThttps://raqm-hr.com/api/employee/insurance/history

Controller: InsuranceController · history

Parameters

No parameters are declared by this route or its request validation.

Example request

curl --request GET 'https://raqm-hr.com/api/employee/insurance/history' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN'

Replace VALUE and :id with real values. The response varies by your account data and permissions.

GET /api/employee/leavesLeavesController · index Bearer Subscription

GEThttps://raqm-hr.com/api/employee/leaves

Controller: LeavesController · index

Parameters

No parameters are declared by this route or its request validation.

Example request

curl --request GET 'https://raqm-hr.com/api/employee/leaves' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN'

Replace VALUE and :id with real values. The response varies by your account data and permissions.

POST /api/employee/leavesLeavesController · store Bearer Subscription

POSThttps://raqm-hr.com/api/employee/leaves

Controller: LeavesController · store

Parameters

NameInRequiredValidation / source

leave_type_idBodyYesrequired|exists:leave_types,id

start_dateBodyYesrequired|date|after_or_equal:today

end_dateBodyYesrequired|date|after_or_equal:start_date

reasonBodyYesrequired|string|max:500

typeBodyNoleave

statusBodyNopending

detailsBodyNoleave_type_id | start_date | end_date | days

Example request

curl --request POST 'https://raqm-hr.com/api/employee/leaves' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
    "leave_type_id": "VALUE",
    "start_date": "YYYY-MM-DD",
    "end_date": "YYYY-MM-DD",
    "reason": "VALUE",
    "type": "VALUE",
    "status": "VALUE",
    "details": "YYYY-MM-DD"
}'

Replace VALUE and :id with real values. The response varies by your account data and permissions.

GET /api/employee/leaves/typesLeavesController · types Bearer Subscription

GEThttps://raqm-hr.com/api/employee/leaves/types

Controller: LeavesController · types

Parameters

No parameters are declared by this route or its request validation.

Example request

curl --request GET 'https://raqm-hr.com/api/employee/leaves/types' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN'

Replace VALUE and :id with real values. The response varies by your account data and permissions.

GET /api/employee/leaves/{id}LeavesController · show Bearer Subscription

GEThttps://raqm-hr.com/api/employee/leaves/{id}

Controller: LeavesController · show

Parameters

NameInRequiredValidation / source

idPathYesRoute parameter

Example request

curl --request GET 'https://raqm-hr.com/api/employee/leaves/:id' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN'

Replace VALUE and :id with real values. The response varies by your account data and permissions.

DELETE /api/employee/leaves/{id}LeavesController · cancel Bearer Subscription

DELETEhttps://raqm-hr.com/api/employee/leaves/{id}

Controller: LeavesController · cancel

Parameters

NameInRequiredValidation / source

idPathYesRoute parameter

Example request

curl --request DELETE 'https://raqm-hr.com/api/employee/leaves/:id' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN'

Replace VALUE and :id with real values. The response varies by your account data and permissions.

POST /api/employee/leaves/{id}/actionRequestsController · processAction Bearer Subscription

POSThttps://raqm-hr.com/api/employee/leaves/{id}/action

Controller: RequestsController · processAction

Parameters

NameInRequiredValidation / source

idPathYesRoute parameter

Example request

curl --request POST 'https://raqm-hr.com/api/employee/leaves/:id/action' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN'

Replace VALUE and :id with real values. The response varies by your account data and permissions.

POST /api/employee/leaves/{id}/approveRequestsController · processAction Bearer Subscription

POSThttps://raqm-hr.com/api/employee/leaves/{id}/approve

Controller: RequestsController · processAction

Parameters

NameInRequiredValidation / source

idPathYesRoute parameter

Example request

curl --request POST 'https://raqm-hr.com/api/employee/leaves/:id/approve' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN'

Replace VALUE and :id with real values. The response varies by your account data and permissions.

POST /api/employee/leaves/{id}/rejectRequestsController · processAction Bearer Subscription

POSThttps://raqm-hr.com/api/employee/leaves/{id}/reject

Controller: RequestsController · processAction

Parameters

NameInRequiredValidation / source

idPathYesRoute parameter

Example request

curl --request POST 'https://raqm-hr.com/api/employee/leaves/:id/reject' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN'

Replace VALUE and :id with real values. The response varies by your account data and permissions.

POST /api/employee/loginAuthController · login Public

POSThttps://raqm-hr.com/api/employee/login

Controller: AuthController · login

Parameters

NameInRequiredValidation / source

employee_numberBodyYesrequired|string

passwordBodyYesrequired|string

device_idBodyYesrequired|string

device_nameBodyNonullable|string

platformBodyNonullable|string

company_idBodyNonullable|integer

company_emailBodyNonullable|string

companyBodyNonullable|string

errorBodyNodevice_limit_exceeded

messageBodyNoMaximum 2 active devices allowed. Please select a device to revoke before continuing.

dataBodyNorequires_revocation | pending_login_token | active_devices

Example request

curl --request POST 'https://raqm-hr.com/api/employee/login' \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{
    "employee_number": "VALUE",
    "password": "VALUE",
    "device_id": "VALUE",
    "device_name": "VALUE",
    "platform": "VALUE",
    "company_id": 0,
    "company_email": "VALUE",
    "company": "VALUE",
    "error": "VALUE",
    "message": "VALUE",
    "data": "VALUE"
}'

Replace VALUE and :id with real values. The response varies by your account data and permissions.

POST /api/employee/logoutAuthController · logout Bearer

POSThttps://raqm-hr.com/api/employee/logout

Controller: AuthController · logout

Parameters

No parameters are declared by this route or its request validation.

Example request

curl --request POST 'https://raqm-hr.com/api/employee/logout' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN'

Replace VALUE and :id with real values. The response varies by your account data and permissions.

POST /api/employee/manager/evaluations/{employee_id}ManagerController · saveEvaluation Bearer Subscription

POSThttps://raqm-hr.com/api/employee/manager/evaluations/{employee_id}

Controller: ManagerController · saveEvaluation

Parameters

NameInRequiredValidation / source

employee_idPathYesRoute parameter

execution_speedBodyYesrequired|numeric|min:0|max:5

work_qualityBodyYesrequired|numeric|min:0|max:5

time_commitmentBodyYesrequired|numeric|min:0|max:5

team_cooperationBodyYesrequired|numeric|min:0|max:5

initiativeBodyYesrequired|numeric|min:0|max:5

strengthsBodyNonullable|string

weaknessesBodyNonullable|string

commentsBodyNonullable|string

nameBodyNoMonthly Evaluation

statusBodyNofinal

Example request

curl --request POST 'https://raqm-hr.com/api/employee/manager/evaluations/:employee_id' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
    "execution_speed": 0,
    "work_quality": 0,
    "time_commitment": 0,
    "team_cooperation": 0,
    "initiative": 0,
    "strengths": "VALUE",
    "weaknesses": "VALUE",
    "comments": "VALUE",
    "name": "VALUE",
    "status": "VALUE"
}'

Replace VALUE and :id with real values. The response varies by your account data and permissions.

POST /api/employee/manager/notesManagerController · addNote Bearer Subscription

POSThttps://raqm-hr.com/api/employee/manager/notes

Controller: ManagerController · addNote

Parameters

NameInRequiredValidation / source

employee_idBodyYesrequired|exists:employees,id

noteBodyYesrequired|string

titleBodyYesrequired|string

tagsBodyYesrequired|array

priorityBodyYesrequired|string

nameBodyNoGeneral Feedback

statusBodyNofinal

Example request

curl --request POST 'https://raqm-hr.com/api/employee/manager/notes' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
    "employee_id": "VALUE",
    "note": "VALUE",
    "title": "VALUE",
    "tags": "VALUE",
    "priority": "VALUE",
    "name": "VALUE",
    "status": "VALUE"
}'

Replace VALUE and :id with real values. The response varies by your account data and permissions.

GET /api/employee/manager/notes/{employee_id}ManagerController · getManagerNotes Bearer Subscription

GEThttps://raqm-hr.com/api/employee/manager/notes/{employee_id}

Controller: ManagerController · getManagerNotes

Parameters

NameInRequiredValidation / source

employee_idPathYesRoute parameter

Example request

curl --request GET 'https://raqm-hr.com/api/employee/manager/notes/:employee_id' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN'

Replace VALUE and :id with real values. The response varies by your account data and permissions.

PUT /api/employee/manager/notes/{id}ManagerController · editNote Bearer Subscription

PUThttps://raqm-hr.com/api/employee/manager/notes/{id}

Controller: ManagerController · editNote

Parameters

NameInRequiredValidation / source

idPathYesRoute parameter

noteBodyYesrequired|string

titleBodyYesrequired|string

tagsBodyYesrequired|array

priorityBodyYesrequired|string

Example request

curl --request PUT 'https://raqm-hr.com/api/employee/manager/notes/:id' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
    "note": "VALUE",
    "title": "VALUE",
    "tags": "VALUE",
    "priority": "VALUE"
}'

Replace VALUE and :id with real values. The response varies by your account data and permissions.

DELETE /api/employee/manager/notes/{id}ManagerController · deleteNote Bearer Subscription

DELETEhttps://raqm-hr.com/api/employee/manager/notes/{id}

Controller: ManagerController · deleteNote

Parameters

NameInRequiredValidation / source

idPathYesRoute parameter

Example request

curl --request DELETE 'https://raqm-hr.com/api/employee/manager/notes/:id' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN'

Replace VALUE and :id with real values. The response varies by your account data and permissions.

POST /api/employee/manager/projectsManagerController · addProject Bearer Subscription

POSThttps://raqm-hr.com/api/employee/manager/projects

Controller: ManagerController · addProject

Parameters

NameInRequiredValidation / source

nameBodyYesrequired|string|max:255

typeBodyYesrequired|string

descriptionBodyNonullable|string

start_dateBodyYesrequired|date

end_dateBodyYesrequired|date|after_or_equal:start_date

team_membersBodyYesrequired|array

attachmentsBodyNonullable|array

statusBodyNoin_progress

roleBodyNomember

document_typeBodyNogeneral

Example request

curl --request POST 'https://raqm-hr.com/api/employee/manager/projects' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
    "name": "VALUE",
    "type": "VALUE",
    "description": "VALUE",
    "start_date": "YYYY-MM-DD",
    "end_date": "YYYY-MM-DD",
    "team_members": "VALUE",
    "attachments": "VALUE",
    "status": "VALUE",
    "role": "VALUE",
    "document_type": "VALUE"
}'

Replace VALUE and :id with real values. The response varies by your account data and permissions.

GET /api/employee/manager/tasks/deliveredManagerController · getDeliveredTasks Bearer Subscription

GEThttps://raqm-hr.com/api/employee/manager/tasks/delivered

Controller: ManagerController · getDeliveredTasks

Parameters

No parameters are declared by this route or its request validation.

Example request

curl --request GET 'https://raqm-hr.com/api/employee/manager/tasks/delivered' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN'

Replace VALUE and :id with real values. The response varies by your account data and permissions.

GET /api/employee/manager/tasks/{id}ManagerController · reviewTask Bearer Subscription

GEThttps://raqm-hr.com/api/employee/manager/tasks/{id}

Controller: ManagerController · reviewTask

Parameters

NameInRequiredValidation / source

idPathYesRoute parameter

Example request

curl --request GET 'https://raqm-hr.com/api/employee/manager/tasks/:id' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN'

Replace VALUE and :id with real values. The response varies by your account data and permissions.

POST /api/employee/manager/tasks/{id}/reviewManagerController · reviewTaskAction Bearer Subscription

POSThttps://raqm-hr.com/api/employee/manager/tasks/{id}/review

Controller: ManagerController · reviewTaskAction

Parameters

NameInRequiredValidation / source

idPathYesRoute parameter

actionBodyYesrequired|in:accept,reject

reasonBodyYesrequired_if:action,reject|nullable|string|max:1000

commentBodyNo[Return Reason]

Example request

curl --request POST 'https://raqm-hr.com/api/employee/manager/tasks/:id/review' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
    "action": "VALUE",
    "reason": "VALUE",
    "comment": "VALUE"
}'

Replace VALUE and :id with real values. The response varies by your account data and permissions.

GET /api/employee/manager/teamManagerController · getTeamMembers Bearer Subscription

GEThttps://raqm-hr.com/api/employee/manager/team

Controller: ManagerController · getTeamMembers

Parameters

No parameters are declared by this route or its request validation.

Example request

curl --request GET 'https://raqm-hr.com/api/employee/manager/team' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN'

Replace VALUE and :id with real values. The response varies by your account data and permissions.

GET /api/employee/meetingsMeetingController · index Bearer Subscription

GEThttps://raqm-hr.com/api/employee/meetings

Controller: MeetingController · index

Parameters

No parameters are declared by this route or its request validation.

Example request

curl --request GET 'https://raqm-hr.com/api/employee/meetings' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN'

Replace VALUE and :id with real values. The response varies by your account data and permissions.

POST /api/employee/meetingsMeetingController · store Bearer Subscription

POSThttps://raqm-hr.com/api/employee/meetings

Controller: MeetingController · store

Parameters

NameInRequiredValidation / source

titleBodyYesrequired|string|max:255

start_timeBodyYesrequired|date

end_timeBodyYesrequired|date|after:start_time

attendeesBodyNonullable|array

typeBodyNomeeting

locationBodyYesnullable|required_if:type,offline

linkBodyYesnullable|required_if:type,online|url

descriptionBodyNonullable|string

team_workspace_idBodyNonullable|exists:team_workspaces,id

statusBodyNopending

Example request

curl --request POST 'https://raqm-hr.com/api/employee/meetings' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
    "title": "VALUE",
    "start_time": "YYYY-MM-DD",
    "end_time": "YYYY-MM-DD",
    "attendees": "VALUE",
    "type": "VALUE",
    "location": "VALUE",
    "link": "VALUE",
    "description": "VALUE",
    "team_workspace_id": "VALUE",
    "status": "VALUE"
}'

Replace VALUE and :id with real values. The response varies by your account data and permissions.

POST /api/employee/meetings/check-conflictsMeetingController · checkConflicts Bearer Subscription

POSThttps://raqm-hr.com/api/employee/meetings/check-conflicts

Controller: MeetingController · checkConflicts

Parameters

NameInRequiredValidation / source

start_timeBodyYesrequired|date

end_timeBodyYesrequired|date|after:start_time

attendeesBodyNonullable|array

except_meeting_idBodyNonullable|integer

Example request

curl --request POST 'https://raqm-hr.com/api/employee/meetings/check-conflicts' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
    "start_time": "YYYY-MM-DD",
    "end_time": "YYYY-MM-DD",
    "attendees": "VALUE",
    "except_meeting_id": 0
}'

Replace VALUE and :id with real values. The response varies by your account data and permissions.

GET /api/employee/meetings/{id}MeetingController · show Bearer Subscription

GEThttps://raqm-hr.com/api/employee/meetings/{id}

Controller: MeetingController · show

Parameters

NameInRequiredValidation / source

idPathYesRoute parameter

Example request

curl --request GET 'https://raqm-hr.com/api/employee/meetings/:id' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN'

Replace VALUE and :id with real values. The response varies by your account data and permissions.

POST /api/employee/meetings/{id}MeetingController · update Bearer Subscription

POSThttps://raqm-hr.com/api/employee/meetings/{id}

Controller: MeetingController · update

Parameters

NameInRequiredValidation / source

idPathYesRoute parameter

titleBodyYesrequired|string|max:255

start_timeBodyYesrequired|date

end_timeBodyYesrequired|date|after:start_time

attendeesBodyNonullable|array

typeBodyYesrequired|in:online,offline

locationBodyYesnullable|required_if:type,offline

linkBodyYesnullable|required_if:type,online|url

descriptionBodyNonullable|string

team_workspace_idBodyNonullable|exists:team_workspaces,id

statusBodyNopending

Example request

curl --request POST 'https://raqm-hr.com/api/employee/meetings/:id' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
    "title": "VALUE",
    "start_time": "YYYY-MM-DD",
    "end_time": "YYYY-MM-DD",
    "attendees": "VALUE",
    "type": "VALUE",
    "location": "VALUE",
    "link": "VALUE",
    "description": "VALUE",
    "team_workspace_id": "VALUE",
    "status": "VALUE"
}'

Replace VALUE and :id with real values. The response varies by your account data and permissions.

DELETE /api/employee/meetings/{id}MeetingController · destroy Bearer Subscription

DELETEhttps://raqm-hr.com/api/employee/meetings/{id}

Controller: MeetingController · destroy

Parameters

NameInRequiredValidation / source

idPathYesRoute parameter

Example request

curl --request DELETE 'https://raqm-hr.com/api/employee/meetings/:id' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN'

Replace VALUE and :id with real values. The response varies by your account data and permissions.

POST /api/employee/meetings/{id}/acceptMeetingController · accept Bearer Subscription

POSThttps://raqm-hr.com/api/employee/meetings/{id}/accept

Controller: MeetingController · accept

Parameters

NameInRequiredValidation / source

idPathYesRoute parameter

statusBodyNoaccepted

Example request

curl --request POST 'https://raqm-hr.com/api/employee/meetings/:id/accept' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
    "status": "VALUE"
}'

Replace VALUE and :id with real values. The response varies by your account data and permissions.

POST /api/employee/meetings/{id}/actionsMeetingController · storeActions Bearer Subscription

POSThttps://raqm-hr.com/api/employee/meetings/{id}/actions

Controller: MeetingController · storeActions

Parameters

NameInRequiredValidation / source

idPathYesRoute parameter

actionsBodyYesrequired|array|min:1

Example request

curl --request POST 'https://raqm-hr.com/api/employee/meetings/:id/actions' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
    "actions": "VALUE"
}'

Replace VALUE and :id with real values. The response varies by your account data and permissions.

POST /api/employee/meetings/{id}/actions/{action}/doneMeetingController · markActionDone Bearer Subscription

POSThttps://raqm-hr.com/api/employee/meetings/{id}/actions/{action}/done

Controller: MeetingController · markActionDone

Parameters

NameInRequiredValidation / source

idPathYesRoute parameter

actionPathYesRoute parameter

Example request

curl --request POST 'https://raqm-hr.com/api/employee/meetings/:id/actions/:action/done' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN'

Replace VALUE and :id with real values. The response varies by your account data and permissions.

POST /api/employee/meetings/{id}/assignMeetingController · assignAttendee Bearer Subscription

POSThttps://raqm-hr.com/api/employee/meetings/{id}/assign

Controller: MeetingController · assignAttendee

Parameters

NameInRequiredValidation / source

idPathYesRoute parameter

employee_idBodyYesrequired|exists:employees,id

statusBodyNopending

typeBodyNomeeting

Example request

curl --request POST 'https://raqm-hr.com/api/employee/meetings/:id/assign' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
    "employee_id": "VALUE",
    "status": "VALUE",
    "type": "VALUE"
}'

Replace VALUE and :id with real values. The response varies by your account data and permissions.

POST /api/employee/meetings/{id}/commentsMeetingController · storeComment Bearer Subscription

POSThttps://raqm-hr.com/api/employee/meetings/{id}/comments

Controller: MeetingController · storeComment

Parameters

NameInRequiredValidation / source

idPathYesRoute parameter

bodyBodyYesrequired|string|max:2000

Example request

curl --request POST 'https://raqm-hr.com/api/employee/meetings/:id/comments' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
    "body": "VALUE"
}'

Replace VALUE and :id with real values. The response varies by your account data and permissions.

POST /api/employee/meetings/{id}/completeMeetingController · complete Bearer Subscription

POSThttps://raqm-hr.com/api/employee/meetings/{id}/complete

Controller: MeetingController · complete

Parameters

NameInRequiredValidation / source

idPathYesRoute parameter

Example request

curl --request POST 'https://raqm-hr.com/api/employee/meetings/:id/complete' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN'

Replace VALUE and :id with real values. The response varies by your account data and permissions.

POST /api/employee/meetings/{id}/declineMeetingController · decline Bearer Subscription

POSThttps://raqm-hr.com/api/employee/meetings/{id}/decline

Controller: MeetingController · decline

Parameters

NameInRequiredValidation / source

idPathYesRoute parameter

statusBodyNodeclined

Example request

curl --request POST 'https://raqm-hr.com/api/employee/meetings/:id/decline' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
    "status": "VALUE"
}'

Replace VALUE and :id with real values. The response varies by your account data and permissions.

POST /api/employee/meetings/{id}/minutesMeetingController · updateMinutes Bearer Subscription

POSThttps://raqm-hr.com/api/employee/meetings/{id}/minutes

Controller: MeetingController · updateMinutes

Parameters

NameInRequiredValidation / source

idPathYesRoute parameter

minutesBodyNonullable|string

Example request

curl --request POST 'https://raqm-hr.com/api/employee/meetings/:id/minutes' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
    "minutes": "VALUE"
}'

Replace VALUE and :id with real values. The response varies by your account data and permissions.

GET /api/employee/modulesDashboardController · getEnabledModules Bearer Subscription

GEThttps://raqm-hr.com/api/employee/modules

Controller: DashboardController · getEnabledModules

Parameters

No parameters are declared by this route or its request validation.

Example request

curl --request GET 'https://raqm-hr.com/api/employee/modules' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN'

Replace VALUE and :id with real values. The response varies by your account data and permissions.

GET /api/employee/monthly-reportMonthlyReportController · index Bearer Subscription

GEThttps://raqm-hr.com/api/employee/monthly-report

Controller: MonthlyReportController · index

Parameters

NameInRequiredValidation / source

periodBodyNoyear | month

summaryBodyNoworking_hours | value | unit | hours

achievementBodyNopercentage | completed | total

tasksBodyNototal_count | active_count

performance_analysisBodyNoweeks

status_distributionBodyNokey | completed | value | color | #10B981

keyBodyNolate

colorBodyNo#EF4444

metricsBodyNoweekly_avg

Example request

curl --request GET 'https://raqm-hr.com/api/employee/monthly-report' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN'

Replace VALUE and :id with real values. The response varies by your account data and permissions.

GET /api/employee/notificationsNotificationController · index Bearer Subscription

GEThttps://raqm-hr.com/api/employee/notifications

Controller: NotificationController · index

Parameters

No parameters are declared by this route or its request validation.

Example request

curl --request GET 'https://raqm-hr.com/api/employee/notifications' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN'

Replace VALUE and :id with real values. The response varies by your account data and permissions.

POST /api/employee/notifications/read-allNotificationController · markAllAsRead Bearer Subscription

POSThttps://raqm-hr.com/api/employee/notifications/read-all

Controller: NotificationController · markAllAsRead

Parameters

No parameters are declared by this route or its request validation.

Example request

curl --request POST 'https://raqm-hr.com/api/employee/notifications/read-all' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN'

Replace VALUE and :id with real values. The response varies by your account data and permissions.

GET /api/employee/notifications/unreadNotificationController · unread Bearer Subscription

GEThttps://raqm-hr.com/api/employee/notifications/unread

Controller: NotificationController · unread

Parameters

No parameters are declared by this route or its request validation.

Example request

curl --request GET 'https://raqm-hr.com/api/employee/notifications/unread' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN'

Replace VALUE and :id with real values. The response varies by your account data and permissions.

GET /api/employee/notifications/unread/countNotificationController · unreadCount Bearer Subscription

GEThttps://raqm-hr.com/api/employee/notifications/unread/count

Controller: NotificationController · unreadCount

Parameters

No parameters are declared by this route or its request validation.

Example request

curl --request GET 'https://raqm-hr.com/api/employee/notifications/unread/count' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN'

Replace VALUE and :id with real values. The response varies by your account data and permissions.

POST /api/employee/notifications/{id}/readNotificationController · markAsRead Bearer Subscription

POSThttps://raqm-hr.com/api/employee/notifications/{id}/read

Controller: NotificationController · markAsRead

Parameters

NameInRequiredValidation / source

idPathYesRoute parameter

Example request

curl --request POST 'https://raqm-hr.com/api/employee/notifications/:id/read' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN'

Replace VALUE and :id with real values. The response varies by your account data and permissions.

GET /api/employee/occasion-campaignsOccasionCampaignController · employeeIndex Bearer Subscription

GEThttps://raqm-hr.com/api/employee/occasion-campaigns

Controller: OccasionCampaignController · employeeIndex

Parameters

No parameters are declared by this route or its request validation.

Example request

curl --request GET 'https://raqm-hr.com/api/employee/occasion-campaigns' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN'

Replace VALUE and :id with real values. The response varies by your account data and permissions.

GET /api/employee/payrollPayrollController · index Bearer Subscription

GEThttps://raqm-hr.com/api/employee/payroll

Controller: PayrollController · index

Parameters

No parameters are declared by this route or its request validation.

Example request

curl --request GET 'https://raqm-hr.com/api/employee/payroll' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN'

Replace VALUE and :id with real values. The response varies by your account data and permissions.

GET /api/employee/penaltiesPenaltiesController · index Bearer Subscription

GEThttps://raqm-hr.com/api/employee/penalties

Controller: PenaltiesController · index

Parameters

No parameters are declared by this route or its request validation.

Example request

curl --request GET 'https://raqm-hr.com/api/employee/penalties' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN'

Replace VALUE and :id with real values. The response varies by your account data and permissions.

GET /api/employee/penalties/{id}PenaltiesController · show Bearer Subscription

GEThttps://raqm-hr.com/api/employee/penalties/{id}

Controller: PenaltiesController · show

Parameters

NameInRequiredValidation / source

idPathYesRoute parameter

Example request

curl --request GET 'https://raqm-hr.com/api/employee/penalties/:id' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN'

Replace VALUE and :id with real values. The response varies by your account data and permissions.

GET /api/employee/performance/goalsPerformanceController · goals Bearer Subscription

GEThttps://raqm-hr.com/api/employee/performance/goals

Controller: PerformanceController · goals

Parameters

No parameters are declared by this route or its request validation.

Example request

curl --request GET 'https://raqm-hr.com/api/employee/performance/goals' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN'

Replace VALUE and :id with real values. The response varies by your account data and permissions.

GET /api/employee/performance/historyPerformanceController · history Bearer Subscription

GEThttps://raqm-hr.com/api/employee/performance/history

Controller: PerformanceController · history

Parameters

No parameters are declared by this route or its request validation.

Example request

curl --request GET 'https://raqm-hr.com/api/employee/performance/history' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN'

Replace VALUE and :id with real values. The response varies by your account data and permissions.

GET /api/employee/performance/notesPerformanceController · notes Bearer Subscription

GEThttps://raqm-hr.com/api/employee/performance/notes

Controller: PerformanceController · notes

Parameters

No parameters are declared by this route or its request validation.

Example request

curl --request GET 'https://raqm-hr.com/api/employee/performance/notes' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN'

Replace VALUE and :id with real values. The response varies by your account data and permissions.

GET /api/employee/performance/summaryPerformanceController · summary Bearer Subscription

GEThttps://raqm-hr.com/api/employee/performance/summary

Controller: PerformanceController · summary

Parameters

NameInRequiredValidation / source

Example request

curl --request GET 'https://raqm-hr.com/api/employee/performance/summary' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN'

Replace VALUE and :id with real values. The response varies by your account data and permissions.

GET /api/employee/profileProfileController · index Bearer Subscription

GEThttps://raqm-hr.com/api/employee/profile

Controller: ProfileController · index

Parameters

No parameters are declared by this route or its request validation.

Example request

curl --request GET 'https://raqm-hr.com/api/employee/profile' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN'

Replace VALUE and :id with real values. The response varies by your account data and permissions.

POST /api/employee/profile/fcm-tokenProfileController · updateFcmToken Bearer Subscription

POSThttps://raqm-hr.com/api/employee/profile/fcm-token

Controller: ProfileController · updateFcmToken

Parameters

NameInRequiredValidation / source

fcm_tokenBodyYesrequired|string|max:500

device_typeBodyNonullable|string|in:android,ios,web

device_nameBodyNonullable|string|max:100

Example request

curl --request POST 'https://raqm-hr.com/api/employee/profile/fcm-token' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
    "fcm_token": "VALUE",
    "device_type": "VALUE",
    "device_name": "VALUE"
}'

Replace VALUE and :id with real values. The response varies by your account data and permissions.

DELETE /api/employee/profile/fcm-tokenProfileController · removeFcmToken Bearer Subscription

DELETEhttps://raqm-hr.com/api/employee/profile/fcm-token

Controller: ProfileController · removeFcmToken

Parameters

No parameters are declared by this route or its request validation.

Example request

curl --request DELETE 'https://raqm-hr.com/api/employee/profile/fcm-token' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN'

Replace VALUE and :id with real values. The response varies by your account data and permissions.

POST /api/employee/profile/updateProfileController · update Bearer Subscription

POSThttps://raqm-hr.com/api/employee/profile/update

Controller: ProfileController · update

Parameters

NameInRequiredValidation / source

phoneBodyNonullable|string|max:20

emailBodyNonullable|email|max:255

addressBodyNonullable|string|max:500

birth_dateBodyNonullable|date

national_idBodyNonullable|string|max:20

passwordBodyNonullable|min:6|confirmed

avatarBodyNonullable|image|max:2048

marital_statusBodyNonullable|in:single,married,divorced,widowed

nationalityBodyNonullable|string|max:100

Example request

curl --request POST 'https://raqm-hr.com/api/employee/profile/update' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
    "phone": "VALUE",
    "email": "VALUE",
    "address": "VALUE",
    "birth_date": "YYYY-MM-DD",
    "national_id": "VALUE",
    "password": "VALUE",
    "avatar": "VALUE",
    "marital_status": "VALUE",
    "nationality": "VALUE"
}'

Replace VALUE and :id with real values. The response varies by your account data and permissions.

GET /api/employee/projectsProjectController · index Bearer Subscription

GEThttps://raqm-hr.com/api/employee/projects

Controller: ProjectController · index

Parameters

No parameters are declared by this route or its request validation.

Example request

curl --request GET 'https://raqm-hr.com/api/employee/projects' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN'

Replace VALUE and :id with real values. The response varies by your account data and permissions.

GET /api/employee/projects/{id}ProjectController · show Bearer Subscription

GEThttps://raqm-hr.com/api/employee/projects/{id}

Controller: ProjectController · show

Parameters

NameInRequiredValidation / source

idPathYesRoute parameter

Example request

curl --request GET 'https://raqm-hr.com/api/employee/projects/:id' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN'

Replace VALUE and :id with real values. The response varies by your account data and permissions.

GET /api/employee/projects/{id}/documentsProjectController · documents Bearer Subscription

GEThttps://raqm-hr.com/api/employee/projects/{id}/documents

Controller: ProjectController · documents

Parameters

NameInRequiredValidation / source

idPathYesRoute parameter

Example request

curl --request GET 'https://raqm-hr.com/api/employee/projects/:id/documents' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN'

Replace VALUE and :id with real values. The response varies by your account data and permissions.

POST /api/employee/projects/{id}/documentsProjectController · storeDocument Bearer Subscription

POSThttps://raqm-hr.com/api/employee/projects/{id}/documents

Controller: ProjectController · storeDocument

Parameters

NameInRequiredValidation / source

idPathYesRoute parameter

fileBodyYesrequired|file|max:10240

document_typeBodyNonullable|string|max:255

notesBodyNonullable|string

Example request

curl --request POST 'https://raqm-hr.com/api/employee/projects/:id/documents' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
    "file": "VALUE",
    "document_type": "VALUE",
    "notes": "VALUE"
}'

Replace VALUE and :id with real values. The response varies by your account data and permissions.

GET /api/employee/projects/{id}/tasksProjectController · tasks Bearer Subscription

GEThttps://raqm-hr.com/api/employee/projects/{id}/tasks

Controller: ProjectController · tasks

Parameters

NameInRequiredValidation / source

idPathYesRoute parameter

Example request

curl --request GET 'https://raqm-hr.com/api/employee/projects/:id/tasks' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN'

Replace VALUE and :id with real values. The response varies by your account data and permissions.

POST /api/employee/projects/{id}/tasksProjectController · storeTask Bearer Subscription

POSThttps://raqm-hr.com/api/employee/projects/{id}/tasks

Controller: ProjectController · storeTask

Parameters

NameInRequiredValidation / source

idPathYesRoute parameter

employee_idBodyNonullable

employee_idsBodyNonullable

task_nameBodyYesrequired|string|max:255

descriptionBodyNonullable|string

start_dateBodyNonullable|date

end_dateBodyNonullable|date|after_or_equal:start_date

statusBodyNonullable|in:pending,in_progress,completed

attachmentsBodyNonullable|array

Example request

curl --request POST 'https://raqm-hr.com/api/employee/projects/:id/tasks' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
    "employee_id": "VALUE",
    "employee_ids": "VALUE",
    "task_name": "VALUE",
    "description": "VALUE",
    "start_date": "YYYY-MM-DD",
    "end_date": "YYYY-MM-DD",
    "status": "VALUE",
    "attachments": "VALUE"
}'

Replace VALUE and :id with real values. The response varies by your account data and permissions.

POST /api/employee/refresh-tokenAuthController · refreshToken Bearer Subscription

POSThttps://raqm-hr.com/api/employee/refresh-token

Controller: AuthController · refreshToken

Parameters

No parameters are declared by this route or its request validation.

Example request

curl --request POST 'https://raqm-hr.com/api/employee/refresh-token' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN'

Replace VALUE and :id with real values. The response varies by your account data and permissions.

GET /api/employee/requestsRequestsController · index Bearer Subscription

GEThttps://raqm-hr.com/api/employee/requests

Controller: RequestsController · index

Parameters

No parameters are declared by this route or its request validation.

Example request

curl --request GET 'https://raqm-hr.com/api/employee/requests' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN'

Replace VALUE and :id with real values. The response varies by your account data and permissions.

POST /api/employee/requests/actionRequestsController · processAction Bearer Subscription

POSThttps://raqm-hr.com/api/employee/requests/action

Controller: RequestsController · processAction

Parameters

No parameters are declared by this route or its request validation.

Example request

curl --request POST 'https://raqm-hr.com/api/employee/requests/action' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN'

Replace VALUE and :id with real values. The response varies by your account data and permissions.

POST /api/employee/requests/adminRequestsController · storeAdmin Bearer Subscription

POSThttps://raqm-hr.com/api/employee/requests/admin

Controller: RequestsController · storeAdmin

Parameters

NameInRequiredValidation / source

typeBodyYesrequired|string

detailsBodyYesrequired|array

statusBodyNopending

Example request

curl --request POST 'https://raqm-hr.com/api/employee/requests/admin' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
    "type": "VALUE",
    "details": "VALUE",
    "status": "VALUE"
}'

Replace VALUE and :id with real values. The response varies by your account data and permissions.

POST /api/employee/requests/advanceRequestsController · storeAdvance Bearer Subscription

POSThttps://raqm-hr.com/api/employee/requests/advance

Controller: RequestsController · storeAdvance

Parameters

NameInRequiredValidation / source

amountBodyYesrequired|numeric|min:1

payment_methodBodyYesrequired|string|in:salary_deduction,other

deduction_dateBodyNonullable|date

installments_countBodyNonullable|integer|min:1

reasonBodyYesrequired|string

other_payment_methodBodyNonullable|in:cash,end_of_service_benefits,vacation_entitlements

statusBodyNopending

typeBodyNoadvance

Example request

curl --request POST 'https://raqm-hr.com/api/employee/requests/advance' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
    "amount": 0,
    "payment_method": "VALUE",
    "deduction_date": "YYYY-MM-DD",
    "installments_count": 0,
    "reason": "VALUE",
    "other_payment_method": "VALUE",
    "status": "VALUE",
    "type": "VALUE"
}'

Replace VALUE and :id with real values. The response varies by your account data and permissions.

GET /api/employee/requests/advance-settingsRequestsController · advanceSettings Bearer Subscription

GEThttps://raqm-hr.com/api/employee/requests/advance-settings

Controller: RequestsController · advanceSettings

Parameters

No parameters are declared by this route or its request validation.

Example request

curl --request GET 'https://raqm-hr.com/api/employee/requests/advance-settings' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN'

Replace VALUE and :id with real values. The response varies by your account data and permissions.

POST /api/employee/requests/attendanceRequestsController · storeAttendance Bearer Subscription

POSThttps://raqm-hr.com/api/employee/requests/attendance

Controller: RequestsController · storeAttendance

Parameters

NameInRequiredValidation / source

typeBodyYesrequired|in:permission,punch_correction,overtime

dateBodyYesrequired|date

reasonBodyYesrequired|string

statusBodyNopending

Example request

curl --request POST 'https://raqm-hr.com/api/employee/requests/attendance' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
    "type": "VALUE",
    "date": "YYYY-MM-DD",
    "reason": "VALUE",
    "status": "VALUE"
}'

Replace VALUE and :id with real values. The response varies by your account data and permissions.

POST /api/employee/requests/commissionRequestsController · storeCommission Bearer Subscription

POSThttps://raqm-hr.com/api/employee/requests/commission

Controller: RequestsController · storeCommission

Parameters

NameInRequiredValidation / source

sales_valueBodyYesrequired|numeric|min:0

sales_dateBodyYesrequired|date

requested_amountBodyYesrequired|numeric|min:0

descriptionBodyNonullable|string

attachmentsBodyNonullable|array

typeBodyNocommission

statusBodyNopending

detailsBodyNosales_value | sales_date | requested_amount | description | attachments

Example request

curl --request POST 'https://raqm-hr.com/api/employee/requests/commission' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
    "sales_value": 0,
    "sales_date": "YYYY-MM-DD",
    "requested_amount": 0,
    "description": "VALUE",
    "attachments": "VALUE",
    "type": "VALUE",
    "status": "VALUE",
    "details": "YYYY-MM-DD"
}'

Replace VALUE and :id with real values. The response varies by your account data and permissions.

POST /api/employee/requests/custodyRequestsController · storeCustody Bearer Subscription

POSThttps://raqm-hr.com/api/employee/requests/custody

Controller: RequestsController · storeCustody

Parameters

NameInRequiredValidation / source

custody_typeBodyYesrequired|string

nameBodyNonullable|string

purposeBodyYesrequired|string

settlement_dateBodyYesrequired|date

amountBodyNonullable|numeric|min:0

attachmentsBodyNonullable|array

typeBodyNocustody

statusBodyNopending

Example request

curl --request POST 'https://raqm-hr.com/api/employee/requests/custody' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
    "custody_type": "VALUE",
    "name": "VALUE",
    "purpose": "VALUE",
    "settlement_date": "YYYY-MM-DD",
    "amount": 0,
    "attachments": "VALUE",
    "type": "VALUE",
    "status": "VALUE",
    "details": "YYYY-MM-DD"
}'

Replace VALUE and :id with real values. The response varies by your account data and permissions.

POST /api/employee/requests/exitRequestsController · storeExit Bearer Subscription

POSThttps://raqm-hr.com/api/employee/requests/exit

Controller: RequestsController · storeExit

Parameters

NameInRequiredValidation / source

dateBodyYesrequired|date

fromBodyYesrequired|string

toBodyYesrequired|string

reasonBodyYesrequired|string

attachmentBodyNonullable|file|max:10240|mimes:jpg,jpeg,png,pdf,doc,docx

typeBodyNoexit

statusBodyNopending

detailsBodyNofrom | to

Example request

curl --request POST 'https://raqm-hr.com/api/employee/requests/exit' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
    "date": "YYYY-MM-DD",
    "from": "VALUE",
    "to": "VALUE",
    "reason": "VALUE",
    "attachment": "VALUE",
    "type": "VALUE",
    "status": "VALUE",
    "details": "VALUE"
}'

Replace VALUE and :id with real values. The response varies by your account data and permissions.

POST /api/employee/requests/financialRequestsController · storeFinancial Bearer Subscription

POSThttps://raqm-hr.com/api/employee/requests/financial

Controller: RequestsController · storeFinancial

Parameters

NameInRequiredValidation / source

typeBodyYesrequired|string

amountBodyYesrequired|numeric|min:1

descriptionBodyYesrequired|string

statusBodyNopending

Example request

curl --request POST 'https://raqm-hr.com/api/employee/requests/financial' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
    "type": "VALUE",
    "amount": 0,
    "description": "VALUE",
    "status": "VALUE"
}'

Replace VALUE and :id with real values. The response varies by your account data and permissions.

POST /api/employee/requests/forgot-punchRequestsController · storeForgotPunch Bearer Subscription

POSThttps://raqm-hr.com/api/employee/requests/forgot-punch

Controller: RequestsController · storeForgotPunch

Parameters

NameInRequiredValidation / source

dateBodyYesrequired|date

punch_typeBodyYesrequired|in:check_in,check_out

timeBodyYesrequired|string

reasonBodyNoنسيت البصمة (

typeBodyNoforgot_punch

statusBodyNopending

detailsBodyNodate | punch_type | time | reason

Example request

curl --request POST 'https://raqm-hr.com/api/employee/requests/forgot-punch' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
    "date": "YYYY-MM-DD",
    "punch_type": "VALUE",
    "time": "VALUE",
    "reason": "VALUE",
    "type": "VALUE",
    "status": "VALUE",
    "details": "YYYY-MM-DD"
}'

Replace VALUE and :id with real values. The response varies by your account data and permissions.

POST /api/employee/requests/housing-allowanceRequestsController · storeHousingAllowance Bearer Subscription

POSThttps://raqm-hr.com/api/employee/requests/housing-allowance

Controller: RequestsController · storeHousingAllowance

Parameters

NameInRequiredValidation / source

allowance_typeBodyYesrequired|string

deduction_dateBodyYesrequired|date

payment_methodBodyNonullable|string

months_countBodyYesrequired|integer|min:1

reasonBodyYesrequired|string

attachmentsBodyNonullable|array

typeBodyNohousing_allowance

statusBodyNopending

detailsBodyNoallowance_type | deduction_date | months_count | attachments

Example request

curl --request POST 'https://raqm-hr.com/api/employee/requests/housing-allowance' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
    "allowance_type": "VALUE",
    "deduction_date": "YYYY-MM-DD",
    "payment_method": "VALUE",
    "months_count": 0,
    "reason": "VALUE",
    "attachments": "VALUE",
    "type": "VALUE",
    "status": "VALUE",
    "details": "YYYY-MM-DD"
}'

Replace VALUE and :id with real values. The response varies by your account data and permissions.

POST /api/employee/requests/insuranceRequestsController · storeInsurance Bearer Subscription

POSThttps://raqm-hr.com/api/employee/requests/insurance

Controller: RequestsController · storeInsurance

Parameters

NameInRequiredValidation / source

request_typeBodyYesrequired|in:add_dependent,upgrade_level

requested_levelBodyNonullable|string

dependentsBodyNonullable|array

dependent_attachmentsBodyNonullable|array

reasonBodyNonullable|string

typeBodyNomedical_insurance

statusBodyNopending

detailsBodyNorequest_type | requested_level | dependents

Example request

curl --request POST 'https://raqm-hr.com/api/employee/requests/insurance' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
    "request_type": "VALUE",
    "requested_level": "VALUE",
    "dependents": "VALUE",
    "dependent_attachments": "VALUE",
    "reason": "VALUE",
    "type": "VALUE",
    "status": "VALUE",
    "details": "VALUE"
}'

Replace VALUE and :id with real values. The response varies by your account data and permissions.

POST /api/employee/requests/leaveRequestsController · storeLeave Bearer Subscription

POSThttps://raqm-hr.com/api/employee/requests/leave

Controller: RequestsController · storeLeave

Parameters

NameInRequiredValidation / source

leave_type_idBodyYesrequired|integer

start_dateBodyYesrequired|date

end_dateBodyYesrequired|date|after_or_equal:start_date

reasonBodyNonullable|string

destinationBodyNonullable|string

backup_person_phoneBodyNonullable|string

backup_person_nameBodyNonullable|string

attachmentBodyNonullable|file|max:10240|mimes:jpg,jpeg,png,pdf,doc,docx

typeBodyNoleave

statusBodyNopending

Example request

curl --request POST 'https://raqm-hr.com/api/employee/requests/leave' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
    "leave_type_id": 0,
    "start_date": "YYYY-MM-DD",
    "end_date": "YYYY-MM-DD",
    "reason": "VALUE",
    "destination": "VALUE",
    "backup_person_phone": "VALUE",
    "backup_person_name": "VALUE",
    "attachment": "VALUE",
    "type": "VALUE",
    "status": "VALUE",
    "details": "YYYY-MM-DD"
}'

Replace VALUE and :id with real values. The response varies by your account data and permissions.

POST /api/employee/requests/letterRequestsController · storeOfficialLetter Bearer Subscription

POSThttps://raqm-hr.com/api/employee/requests/letter

Controller: RequestsController · storeOfficialLetter

Parameters

NameInRequiredValidation / source

letter_typeBodyYesrequired|in:employment,experience,salary_certificate

languageBodyYesrequired|in:ar,en,both

addressed_toBodyYesrequired|string

delivery_modeBodyYesrequired|string

chamber_authBodyNonullable

salary_report_typeBodyNonullable|in:total,detailed

reasonBodyNonullable|string

proposed_templateBodyNonullable|file|max:10240|mimes:pdf,doc,docx,jpg,jpeg,png

typeBodyNoletter

statusBodyNopending

Example request

curl --request POST 'https://raqm-hr.com/api/employee/requests/letter' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
    "letter_type": "VALUE",
    "language": "VALUE",
    "addressed_to": "VALUE",
    "delivery_mode": "VALUE",
    "chamber_auth": "VALUE",
    "salary_report_type": "VALUE",
    "reason": "VALUE",
    "proposed_template": "VALUE",
    "type": "VALUE",
    "status": "VALUE",
    "details": "VALUE"
}'

Replace VALUE and :id with real values. The response varies by your account data and permissions.

POST /api/employee/requests/loanRequestsController · storeLoan Bearer Subscription

POSThttps://raqm-hr.com/api/employee/requests/loan

Controller: RequestsController · storeLoan

Parameters

No parameters are declared by this route or its request validation.

Example request

curl --request POST 'https://raqm-hr.com/api/employee/requests/loan' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN'

Replace VALUE and :id with real values. The response varies by your account data and permissions.

POST /api/employee/requests/maternityRequestsController · storeMaternity Bearer Subscription

POSThttps://raqm-hr.com/api/employee/requests/maternity

Controller: RequestsController · storeMaternity

Parameters

NameInRequiredValidation / source

start_dateBodyYesrequired|date

end_dateBodyYesrequired|date|after_or_equal:start_date

expected_birth_dateBodyNonullable|date

destinationBodyNonullable|string

backup_person_phoneBodyNonullable|string

backup_person_nameBodyNonullable|string

attachmentsBodyNonullable|array

typeBodyNomaternity

statusBodyNopending

reasonBodyNoMaternity leave request

Example request

curl --request POST 'https://raqm-hr.com/api/employee/requests/maternity' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
    "start_date": "YYYY-MM-DD",
    "end_date": "YYYY-MM-DD",
    "expected_birth_date": "YYYY-MM-DD",
    "destination": "VALUE",
    "backup_person_phone": "VALUE",
    "backup_person_name": "VALUE",
    "attachments": "VALUE",
    "type": "VALUE",
    "status": "VALUE",
    "reason": "VALUE",
    "details": "YYYY-MM-DD"
}'

Replace VALUE and :id with real values. The response varies by your account data and permissions.

POST /api/employee/requests/mission-allowanceRequestsController · storeMissionAllowance Bearer Subscription

POSThttps://raqm-hr.com/api/employee/requests/mission-allowance

Controller: RequestsController · storeMissionAllowance

Parameters

NameInRequiredValidation / source

mission_locationBodyYesrequired|string

start_dateBodyYesrequired|date

end_dateBodyYesrequired|date|after_or_equal:start_date

daily_rateBodyNonullable|numeric|min:0

reasonBodyNonullable|string

requirementsBodyNonullable|string|in:flight_tickets,car,train,bus,ship

hotel_bookingBodyNonullable|in:0,1

country_idBodyNonullable|exists:countries,id

city_idBodyNonullable|exists:cities,id

attachmentsBodyNonullable|array

typeBodyNomission_allowance

statusBodyNopending

Example request

curl --request POST 'https://raqm-hr.com/api/employee/requests/mission-allowance' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
    "mission_location": "VALUE",
    "start_date": "YYYY-MM-DD",
    "end_date": "YYYY-MM-DD",
    "daily_rate": 0,
    "reason": "VALUE",
    "requirements": "VALUE",
    "hotel_booking": "VALUE",
    "country_id": "VALUE",
    "city_id": "VALUE",
    "attachments": "VALUE",
    "type": "VALUE",
    "status": "VALUE",
    "details": "YYYY-MM-DD"
}'

Replace VALUE and :id with real values. The response varies by your account data and permissions.

POST /api/employee/requests/overtimeRequestsController · storeOvertime Bearer Subscription

POSThttps://raqm-hr.com/api/employee/requests/overtime

Controller: RequestsController · storeOvertime

Parameters

NameInRequiredValidation / source

hours_countBodyYesrequired|numeric|min:0.5

start_timeBodyYesrequired|string

end_timeBodyYesrequired|string

task_idBodyNonullable|integer

dateBodyYesrequired|date

descriptionBodyNonullable|string

attachmentsBodyNonullable|array

typeBodyNoovertime

statusBodyNopending

Example request

curl --request POST 'https://raqm-hr.com/api/employee/requests/overtime' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
    "hours_count": 0,
    "start_time": "VALUE",
    "end_time": "VALUE",
    "task_id": 0,
    "date": "YYYY-MM-DD",
    "description": "VALUE",
    "attachments": "VALUE",
    "type": "VALUE",
    "status": "VALUE",
    "details": "YYYY-MM-DD"
}'

Replace VALUE and :id with real values. The response varies by your account data and permissions.

POST /api/employee/requests/permissionRequestsController · storePermission Bearer Subscription

POSThttps://raqm-hr.com/api/employee/requests/permission

Controller: RequestsController · storePermission

Parameters

NameInRequiredValidation / source

dateBodyYesrequired|date

from_timeBodyYesrequired|string

reasonBodyYesrequired|string

typeBodyNopermission

statusBodyNopending

detailsBodyNofrom_time | H:i | to_time | H:i | hours_count

Example request

curl --request POST 'https://raqm-hr.com/api/employee/requests/permission' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
    "date": "YYYY-MM-DD",
    "from_time": "VALUE",
    "reason": "VALUE",
    "type": "VALUE",
    "status": "VALUE",
    "details": "VALUE"
}'

Replace VALUE and :id with real values. The response varies by your account data and permissions.

GET /api/employee/requests/postponable-installmentsRequestsController · getPostponableInstallments Bearer Subscription

GEThttps://raqm-hr.com/api/employee/requests/postponable-installments

Controller: RequestsController · getPostponableInstallments

Parameters

No parameters are declared by this route or its request validation.

Example request

curl --request GET 'https://raqm-hr.com/api/employee/requests/postponable-installments' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN'

Replace VALUE and :id with real values. The response varies by your account data and permissions.

POST /api/employee/requests/postponeRequestsController · storePostponement Bearer Subscription

POSThttps://raqm-hr.com/api/employee/requests/postpone

Controller: RequestsController · storePostponement

Parameters

NameInRequiredValidation / source

installment_idBodyYesrequired|exists:loan_installments,id

reasonBodyYesrequired|string

typeBodyNopostpone_installment

statusBodyNopending

detailsBodyNoinstallment_id | installment_date | Y-m-d | amount

Example request

curl --request POST 'https://raqm-hr.com/api/employee/requests/postpone' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
    "installment_id": "VALUE",
    "reason": "VALUE",
    "type": "VALUE",
    "status": "VALUE",
    "details": "YYYY-MM-DD"
}'

Replace VALUE and :id with real values. The response varies by your account data and permissions.

POST /api/employee/requests/punch-correctionRequestsController · storePunchCorrection Bearer Subscription

POSThttps://raqm-hr.com/api/employee/requests/punch-correction

Controller: RequestsController · storePunchCorrection

Parameters

NameInRequiredValidation / source

new_shiftBodyYesrequired|string

start_dateBodyYesrequired|date

end_dateBodyYesrequired|date|after_or_equal:start_date

reasonBodyNonullable|string

typeBodyNopunch_correction

statusBodyNopending

detailsBodyNonew_shift | start_date | end_date

Example request

curl --request POST 'https://raqm-hr.com/api/employee/requests/punch-correction' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
    "new_shift": "VALUE",
    "start_date": "YYYY-MM-DD",
    "end_date": "YYYY-MM-DD",
    "reason": "VALUE",
    "type": "VALUE",
    "status": "VALUE",
    "details": "YYYY-MM-DD"
}'

Replace VALUE and :id with real values. The response varies by your account data and permissions.

POST /api/employee/requests/reimbursementRequestsController · storeReimbursement Bearer Subscription

POSThttps://raqm-hr.com/api/employee/requests/reimbursement

Controller: RequestsController · storeReimbursement

Parameters

NameInRequiredValidation / source

expense_typeBodyYesrequired|string

expense_dateBodyYesrequired|date

amountBodyNonullable|numeric|min:0

descriptionBodyNonullable|string

custody_request_idBodyNonullable

attachmentsBodyNonullable|array

typeBodyNoreimbursement

statusBodyNopending

Example request

curl --request POST 'https://raqm-hr.com/api/employee/requests/reimbursement' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
    "expense_type": "VALUE",
    "expense_date": "YYYY-MM-DD",
    "amount": 0,
    "description": "VALUE",
    "custody_request_id": "VALUE",
    "attachments": "VALUE",
    "type": "VALUE",
    "status": "VALUE",
    "details": "YYYY-MM-DD"
}'

Replace VALUE and :id with real values. The response varies by your account data and permissions.

POST /api/employee/requests/residence-renewalRequestsController · storeResidenceRenewal Bearer Subscription

POSThttps://raqm-hr.com/api/employee/requests/residence-renewal

Controller: RequestsController · storeResidenceRenewal

Parameters

NameInRequiredValidation / source

requested_durationBodyNonullable|string

delivery_locationBodyYesrequired|string

attachmentsBodyNonullable|array

typeBodyNoresidence_renewal

statusBodyNopending

reasonBodyNoResidence renewal request

detailsBodyNorequested_duration | delivery_location | attachments

Example request

curl --request POST 'https://raqm-hr.com/api/employee/requests/residence-renewal' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
    "requested_duration": "VALUE",
    "delivery_location": "VALUE",
    "attachments": "VALUE",
    "type": "VALUE",
    "status": "VALUE",
    "reason": "VALUE",
    "details": "VALUE"
}'

Replace VALUE and :id with real values. The response varies by your account data and permissions.

POST /api/employee/requests/resignationRequestsController · storeResignation Bearer Subscription

POSThttps://raqm-hr.com/api/employee/requests/resignation

Controller: RequestsController · storeResignation

Parameters

NameInRequiredValidation / source

last_dayBodyYesrequired|date

reasonBodyNonullable|string

notesBodyNonullable|string

attachmentBodyNonullable|file|max:10240|mimes:jpg,jpeg,png,pdf,doc,docx

typeBodyNoresignation

statusBodyNopending

detailsBodyNoreason | notes | last_day | attachment

Example request

curl --request POST 'https://raqm-hr.com/api/employee/requests/resignation' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
    "last_day": "YYYY-MM-DD",
    "reason": "VALUE",
    "notes": "VALUE",
    "attachment": "VALUE",
    "type": "VALUE",
    "status": "VALUE",
    "details": "VALUE"
}'

Replace VALUE and :id with real values. The response varies by your account data and permissions.

POST /api/employee/requests/trainingRequestsController · storeTraining Bearer Subscription

POSThttps://raqm-hr.com/api/employee/requests/training

Controller: RequestsController · storeTraining

Parameters

NameInRequiredValidation / source

training_nameBodyYesrequired|string

providerBodyNonullable|string

amountBodyNonullable|numeric|min:0

start_dateBodyYesrequired|date

end_dateBodyYesrequired|date|after_or_equal:start_date

reasonBodyNonullable|string

attachmentsBodyNonullable|array

typeBodyNotraining

statusBodyNopending

Example request

curl --request POST 'https://raqm-hr.com/api/employee/requests/training' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
    "training_name": "VALUE",
    "provider": "VALUE",
    "amount": 0,
    "start_date": "YYYY-MM-DD",
    "end_date": "YYYY-MM-DD",
    "reason": "VALUE",
    "attachments": "VALUE",
    "type": "VALUE",
    "status": "VALUE",
    "details": "YYYY-MM-DD"
}'

Replace VALUE and :id with real values. The response varies by your account data and permissions.

POST /api/employee/requests/transport-allowanceRequestsController · storeTransportAllowance Bearer Subscription

POSThttps://raqm-hr.com/api/employee/requests/transport-allowance

Controller: RequestsController · storeTransportAllowance

Parameters

NameInRequiredValidation / source

allowance_typeBodyYesrequired|string

deduction_dateBodyYesrequired|date

payment_methodBodyYesrequired|string

months_countBodyYesrequired|integer|min:1

amountBodyNonullable|numeric|min:0.01

reasonBodyYesrequired|string

attachmentsBodyNonullable|array

typeBodyNotransport_allowance

statusBodyNopending

Example request

curl --request POST 'https://raqm-hr.com/api/employee/requests/transport-allowance' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
    "allowance_type": "VALUE",
    "deduction_date": "YYYY-MM-DD",
    "payment_method": "VALUE",
    "months_count": 0,
    "amount": 0,
    "reason": "VALUE",
    "attachments": "VALUE",
    "type": "VALUE",
    "status": "VALUE",
    "details": "YYYY-MM-DD"
}'

Replace VALUE and :id with real values. The response varies by your account data and permissions.

POST /api/employee/requests/visit-authRequestsController · storeVisitAuth Bearer Subscription

POSThttps://raqm-hr.com/api/employee/requests/visit-auth

Controller: RequestsController · storeVisitAuth

Parameters

NameInRequiredValidation / source

auth_request_detailsBodyYesrequired|string

submission_dateBodyYesrequired|date

request_documentBodyNonullable|file|max:10240|mimes:jpg,jpeg,png,pdf,doc,docx

typeBodyNovisit_auth

statusBodyNopending

detailsBodyNoauth_request_details | submission_date | request_document

Example request

curl --request POST 'https://raqm-hr.com/api/employee/requests/visit-auth' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
    "auth_request_details": "VALUE",
    "submission_date": "YYYY-MM-DD",
    "request_document": "VALUE",
    "type": "VALUE",
    "status": "VALUE",
    "details": "YYYY-MM-DD"
}'

Replace VALUE and :id with real values. The response varies by your account data and permissions.

POST /api/employee/requests/visit-visaRequestsController · storeVisitVisa Bearer Subscription

POSThttps://raqm-hr.com/api/employee/requests/visit-visa

Controller: RequestsController · storeVisitVisa

Parameters

NameInRequiredValidation / source

visit_typeBodyYesrequired|string

submitted_toBodyYesrequired|string

visitor_full_nameBodyYesrequired|string

visitor_passport_numberBodyYesrequired|string

visitor_nationalityBodyYesrequired|string

visitor_emailBodyNonullable|email

visitor_phoneBodyYesrequired|string

passport_imageBodyNonullable|file|max:10240|mimes:jpg,jpeg,png,pdf

notesBodyNonullable|string

typeBodyNovisit_visa

statusBodyNopending

reasonBodyNoVisit visa request for

Example request

curl --request POST 'https://raqm-hr.com/api/employee/requests/visit-visa' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
    "visit_type": "VALUE",
    "submitted_to": "VALUE",
    "visitor_full_name": "VALUE",
    "visitor_passport_number": "VALUE",
    "visitor_nationality": "VALUE",
    "visitor_email": "VALUE",
    "visitor_phone": "VALUE",
    "passport_image": "VALUE",
    "notes": "VALUE",
    "type": "VALUE",
    "status": "VALUE",
    "reason": "VALUE",
    "details": "VALUE"
}'

Replace VALUE and :id with real values. The response varies by your account data and permissions.

POST /api/employee/requests/work-from-homeRequestsController · storeWorkFromHome Bearer Subscription

POSThttps://raqm-hr.com/api/employee/requests/work-from-home

Controller: RequestsController · storeWorkFromHome

Parameters

NameInRequiredValidation / source

start_dateBodyYesrequired|date

end_dateBodyYesrequired|date|after_or_equal:start_date

reasonBodyNonullable|string

attachmentBodyNonullable|file|max:10240|mimes:jpg,jpeg,png,pdf,doc,docx

typeBodyNowork_from_home

statusBodyNopending

detailsBodyNostart_date | end_date | days

Example request

curl --request POST 'https://raqm-hr.com/api/employee/requests/work-from-home' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
    "start_date": "YYYY-MM-DD",
    "end_date": "YYYY-MM-DD",
    "reason": "VALUE",
    "attachment": "VALUE",
    "type": "VALUE",
    "status": "VALUE",
    "details": "YYYY-MM-DD"
}'

Replace VALUE and :id with real values. The response varies by your account data and permissions.

GET /api/employee/requests/{id}RequestsController · show Bearer Subscription

GEThttps://raqm-hr.com/api/employee/requests/{id}

Controller: RequestsController · show

Parameters

NameInRequiredValidation / source

idPathYesRoute parameter

Example request

curl --request GET 'https://raqm-hr.com/api/employee/requests/:id' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN'

Replace VALUE and :id with real values. The response varies by your account data and permissions.

POST /api/employee/requests/{id}/actionRequestsController · processAction Bearer Subscription

POSThttps://raqm-hr.com/api/employee/requests/{id}/action

Controller: RequestsController · processAction

Parameters

NameInRequiredValidation / source

idPathYesRoute parameter

Example request

curl --request POST 'https://raqm-hr.com/api/employee/requests/:id/action' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN'

Replace VALUE and :id with real values. The response varies by your account data and permissions.

POST /api/employee/requests/{id}/approveRequestsController · processAction Bearer Subscription

POSThttps://raqm-hr.com/api/employee/requests/{id}/approve

Controller: RequestsController · processAction

Parameters

NameInRequiredValidation / source

idPathYesRoute parameter

Example request

curl --request POST 'https://raqm-hr.com/api/employee/requests/:id/approve' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN'

Replace VALUE and :id with real values. The response varies by your account data and permissions.

POST /api/employee/requests/{id}/rejectRequestsController · processAction Bearer Subscription

POSThttps://raqm-hr.com/api/employee/requests/{id}/reject

Controller: RequestsController · processAction

Parameters

NameInRequiredValidation / source

idPathYesRoute parameter

Example request

curl --request POST 'https://raqm-hr.com/api/employee/requests/:id/reject' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN'

Replace VALUE and :id with real values. The response varies by your account data and permissions.

GET /api/employee/required-documentsRequiredDocumentsController · status Bearer Subscription

GEThttps://raqm-hr.com/api/employee/required-documents

Controller: RequiredDocumentsController · status

Parameters

No parameters are declared by this route or its request validation.

Example request

curl --request GET 'https://raqm-hr.com/api/employee/required-documents' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN'

Replace VALUE and :id with real values. The response varies by your account data and permissions.

POST /api/employee/required-documentsRequiredDocumentsController · upload Bearer Subscription

POSThttps://raqm-hr.com/api/employee/required-documents

Controller: RequiredDocumentsController · upload

Parameters

NameInRequiredValidation / source

document_typeBodyYesrequired|string|in:

fileBodyYesrequired|file|mimes:pdf,jpg,jpeg,png|max:10240

Example request

curl --request POST 'https://raqm-hr.com/api/employee/required-documents' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
    "document_type": "VALUE",
    "file": "VALUE"
}'

Replace VALUE and :id with real values. The response varies by your account data and permissions.

GET /api/employee/salesSalesController · index Bearer Subscription

GEThttps://raqm-hr.com/api/employee/sales

Controller: SalesController · index

Parameters

NameInRequiredValidation / source

metricsBodyNototal_clients | total_invoices | total_collected

Example request

curl --request GET 'https://raqm-hr.com/api/employee/sales' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN'

Replace VALUE and :id with real values. The response varies by your account data and permissions.

GET /api/employee/sales/clientsSalesController · clients Bearer Subscription

GEThttps://raqm-hr.com/api/employee/sales/clients

Controller: SalesController · clients

Parameters

No parameters are declared by this route or its request validation.

Example request

curl --request GET 'https://raqm-hr.com/api/employee/sales/clients' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN'

Replace VALUE and :id with real values. The response varies by your account data and permissions.

POST /api/employee/sales/clientsSalesController · storeClient Bearer Subscription

POSThttps://raqm-hr.com/api/employee/sales/clients

Controller: SalesController · storeClient

Parameters

NameInRequiredValidation / source

nameBodyYesrequired|string|max:255

emailBodyNonullable|email|max:255

phoneBodyNonullable|string|max:20

addressBodyNonullable|string

national_idBodyNonullable|string|max:50

Example request

curl --request POST 'https://raqm-hr.com/api/employee/sales/clients' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
    "name": "VALUE",
    "email": "VALUE",
    "phone": "VALUE",
    "address": "VALUE",
    "national_id": "VALUE"
}'

Replace VALUE and :id with real values. The response varies by your account data and permissions.

POST /api/employee/sales/collectionsSalesController · storeCollection Bearer Subscription

POSThttps://raqm-hr.com/api/employee/sales/collections

Controller: SalesController · storeCollection

Parameters

NameInRequiredValidation / source

invoice_idBodyYesrequired|exists:invoices,id

amountBodyYesrequired|numeric|min:0

collection_dateBodyYesrequired|date

payment_methodBodyYesrequired|in:cash,bank_transfer,check

noteBodyNonullable|string

statusBodyNopartial

Example request

curl --request POST 'https://raqm-hr.com/api/employee/sales/collections' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
    "invoice_id": "VALUE",
    "amount": 0,
    "collection_date": "YYYY-MM-DD",
    "payment_method": "VALUE",
    "note": "VALUE",
    "status": "VALUE"
}'

Replace VALUE and :id with real values. The response varies by your account data and permissions.

POST /api/employee/sales/invoicesSalesController · storeInvoice Bearer Subscription

POSThttps://raqm-hr.com/api/employee/sales/invoices

Controller: SalesController · storeInvoice

Parameters

NameInRequiredValidation / source

client_idBodyYesrequired|exists:clients,id

invoice_numberBodyYesrequired|string|unique:invoices,invoice_number

amountBodyYesrequired|numeric|min:0

due_dateBodyYesrequired|date

statusBodyNopending

Example request

curl --request POST 'https://raqm-hr.com/api/employee/sales/invoices' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
    "client_id": "VALUE",
    "invoice_number": "VALUE",
    "amount": 0,
    "due_date": "YYYY-MM-DD",
    "status": "VALUE"
}'

Replace VALUE and :id with real values. The response varies by your account data and permissions.

POST /api/employee/sales/location/updateSalesController · updateLocation Bearer Subscription

POSThttps://raqm-hr.com/api/employee/sales/location/update

Controller: SalesController · updateLocation

Parameters

NameInRequiredValidation / source

latitudeBodyYesrequired|numeric

longitudeBodyYesrequired|numeric

Example request

curl --request POST 'https://raqm-hr.com/api/employee/sales/location/update' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
    "latitude": 0,
    "longitude": 0
}'

Replace VALUE and :id with real values. The response varies by your account data and permissions.

GET /api/employee/sales/visit-typesSalesController · visitTypes Bearer Subscription

GEThttps://raqm-hr.com/api/employee/sales/visit-types

Controller: SalesController · visitTypes

Parameters

No parameters are declared by this route or its request validation.

Example request

curl --request GET 'https://raqm-hr.com/api/employee/sales/visit-types' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN'

Replace VALUE and :id with real values. The response varies by your account data and permissions.

GET /api/employee/sales/visitsSalesController · visits Bearer Subscription

GEThttps://raqm-hr.com/api/employee/sales/visits

Controller: SalesController · visits

Parameters

No parameters are declared by this route or its request validation.

Example request

curl --request GET 'https://raqm-hr.com/api/employee/sales/visits' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN'

Replace VALUE and :id with real values. The response varies by your account data and permissions.

POST /api/employee/sales/visitsSalesController · storeVisit Bearer Subscription

POSThttps://raqm-hr.com/api/employee/sales/visits

Controller: SalesController · storeVisit

Parameters

NameInRequiredValidation / source

modeBodyYesrequired|in:existing,new

client_idBodyYesnullable|required_if:mode,existing|exists:clients,id

place_nameBodyYesnullable|required_if:mode,new|string|max:255

place_addressBodyNonullable|string

phoneBodyNonullable|string|max:20

national_idBodyNonullable|string|max:50

visit_typeBodyYesrequired|in:

notesBodyNonullable|string|max:1000

latitudeBodyNonullable|numeric

longitudeBodyNonullable|numeric

Example request

curl --request POST 'https://raqm-hr.com/api/employee/sales/visits' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
    "mode": "VALUE",
    "client_id": "VALUE",
    "place_name": "VALUE",
    "place_address": "VALUE",
    "phone": "VALUE",
    "national_id": "VALUE",
    "visit_type": "VALUE",
    "notes": "VALUE",
    "latitude": 0,
    "longitude": 0
}'

Replace VALUE and :id with real values. The response varies by your account data and permissions.

GET /api/employee/scheduleScheduleController · index Bearer Subscription

GEThttps://raqm-hr.com/api/employee/schedule

Controller: ScheduleController · index

Parameters

No parameters are declared by this route or its request validation.

Example request

curl --request GET 'https://raqm-hr.com/api/employee/schedule' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN'

Replace VALUE and :id with real values. The response varies by your account data and permissions.

GET /api/employee/schedule/currentScheduleController · current Bearer Subscription

GEThttps://raqm-hr.com/api/employee/schedule/current

Controller: ScheduleController · current

Parameters

No parameters are declared by this route or its request validation.

Example request

curl --request GET 'https://raqm-hr.com/api/employee/schedule/current' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN'

Replace VALUE and :id with real values. The response varies by your account data and permissions.

GET /api/employee/shiftsShiftController · index Bearer Subscription

GEThttps://raqm-hr.com/api/employee/shifts

Controller: ShiftController · index

Parameters

No parameters are declared by this route or its request validation.

Example request

curl --request GET 'https://raqm-hr.com/api/employee/shifts' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN'

Replace VALUE and :id with real values. The response varies by your account data and permissions.

GET /api/employee/shifts/my-shiftShiftController · myShift Bearer Subscription

GEThttps://raqm-hr.com/api/employee/shifts/my-shift

Controller: ShiftController · myShift

Parameters

NameInRequiredValidation / source

sourceBodyNowork_schedule

Example request

curl --request GET 'https://raqm-hr.com/api/employee/shifts/my-shift' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN'

Replace VALUE and :id with real values. The response varies by your account data and permissions.

GET /api/employee/shifts/{id}ShiftController · show Bearer Subscription

GEThttps://raqm-hr.com/api/employee/shifts/{id}

Controller: ShiftController · show

Parameters

NameInRequiredValidation / source

idPathYesRoute parameter

Example request

curl --request GET 'https://raqm-hr.com/api/employee/shifts/:id' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN'

Replace VALUE and :id with real values. The response varies by your account data and permissions.

GET /api/employee/subtasks/{subtaskId}SubtasksController · show Bearer Subscription

GEThttps://raqm-hr.com/api/employee/subtasks/{subtaskId}

Controller: SubtasksController · show

Parameters

NameInRequiredValidation / source

subtaskIdPathYesRoute parameter

Example request

curl --request GET 'https://raqm-hr.com/api/employee/subtasks/:subtaskId' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN'

Replace VALUE and :id with real values. The response varies by your account data and permissions.

PUT /api/employee/subtasks/{subtaskId}SubtasksController · update Bearer Subscription

PUThttps://raqm-hr.com/api/employee/subtasks/{subtaskId}

Controller: SubtasksController · update

Parameters

NameInRequiredValidation / source

subtaskIdPathYesRoute parameter

titleBodyYesrequired|string|max:255

descriptionBodyNonullable|string

statusBodyNonullable|in:new,in_progress,review,completed,cancelled

priorityBodyNonullable|in:low,medium,high,urgent

assigned_toBodyNonullable|exists:employees,id

employee_idsBodyNonullable|array

start_dateBodyNonullable|date

end_dateBodyNonullable|date

estimated_hoursBodyNonullable|numeric|min:0

progressBodyNonullable|integer|min:0|max:100

Example request

curl --request PUT 'https://raqm-hr.com/api/employee/subtasks/:subtaskId' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
    "title": "VALUE",
    "description": "VALUE",
    "status": "VALUE",
    "priority": "VALUE",
    "assigned_to": "VALUE",
    "employee_ids": "VALUE",
    "start_date": "YYYY-MM-DD",
    "end_date": "YYYY-MM-DD",
    "estimated_hours": 0,
    "progress": 0
}'

Replace VALUE and :id with real values. The response varies by your account data and permissions.

DELETE /api/employee/subtasks/{subtaskId}SubtasksController · destroy Bearer Subscription

DELETEhttps://raqm-hr.com/api/employee/subtasks/{subtaskId}

Controller: SubtasksController · destroy

Parameters

NameInRequiredValidation / source

subtaskIdPathYesRoute parameter

Example request

curl --request DELETE 'https://raqm-hr.com/api/employee/subtasks/:subtaskId' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN'

Replace VALUE and :id with real values. The response varies by your account data and permissions.

GET /api/employee/subtasks/{subtaskId}/commentsSubtasksController · getComments Bearer Subscription

GEThttps://raqm-hr.com/api/employee/subtasks/{subtaskId}/comments

Controller: SubtasksController · getComments

Parameters

NameInRequiredValidation / source

subtaskIdPathYesRoute parameter

Example request

curl --request GET 'https://raqm-hr.com/api/employee/subtasks/:subtaskId/comments' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN'

Replace VALUE and :id with real values. The response varies by your account data and permissions.

POST /api/employee/subtasks/{subtaskId}/commentsSubtasksController · storeComment Bearer Subscription

POSThttps://raqm-hr.com/api/employee/subtasks/{subtaskId}/comments

Controller: SubtasksController · storeComment

Parameters

NameInRequiredValidation / source

subtaskIdPathYesRoute parameter

commentBodyYesrequired|string

parent_idBodyNonullable|exists:subtask_comments,id

attachmentBodyNonullable|file|max:10240

Example request

curl --request POST 'https://raqm-hr.com/api/employee/subtasks/:subtaskId/comments' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
    "comment": "VALUE",
    "parent_id": "VALUE",
    "attachment": "VALUE"
}'

Replace VALUE and :id with real values. The response varies by your account data and permissions.

POST /api/employee/subtasks/{subtaskId}/toggleSubtasksController · toggle Bearer Subscription

POSThttps://raqm-hr.com/api/employee/subtasks/{subtaskId}/toggle

Controller: SubtasksController · toggle

Parameters

NameInRequiredValidation / source

subtaskIdPathYesRoute parameter

Example request

curl --request POST 'https://raqm-hr.com/api/employee/subtasks/:subtaskId/toggle' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN'

Replace VALUE and :id with real values. The response varies by your account data and permissions.

GET /api/employee/tasksTasksController · index Bearer Subscription

GEThttps://raqm-hr.com/api/employee/tasks

Controller: TasksController · index

Parameters

NameInRequiredValidation / source

under_reviewBodyNoreview | under_review

deliveredBodyNocompleted | delivered

Example request

curl --request GET 'https://raqm-hr.com/api/employee/tasks' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN'

Replace VALUE and :id with real values. The response varies by your account data and permissions.

POST /api/employee/tasks/{id}/commentsProjectController · storeComment Bearer Subscription

POSThttps://raqm-hr.com/api/employee/tasks/{id}/comments

Controller: ProjectController · storeComment

Parameters

NameInRequiredValidation / source

idPathYesRoute parameter

commentBodyYesrequired|string|max:5000

Example request

curl --request POST 'https://raqm-hr.com/api/employee/tasks/:id/comments' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
    "comment": "VALUE"
}'

Replace VALUE and :id with real values. The response varies by your account data and permissions.

POST /api/employee/tasks/{id}/finishTasksController · finish Bearer Subscription

POSThttps://raqm-hr.com/api/employee/tasks/{id}/finish

Controller: TasksController · finish

Parameters

NameInRequiredValidation / source

idPathYesRoute parameter

documentBodyNonullable|file|max:5120

statusBodyNoreview

Example request

curl --request POST 'https://raqm-hr.com/api/employee/tasks/:id/finish' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
    "document": "VALUE",
    "status": "VALUE"
}'

Replace VALUE and :id with real values. The response varies by your account data and permissions.

PATCH /api/employee/tasks/{id}/statusTasksController · updateStatus Bearer Subscription

PATCHhttps://raqm-hr.com/api/employee/tasks/{id}/status

Controller: TasksController · updateStatus

Parameters

NameInRequiredValidation / source

idPathYesRoute parameter

statusBodyYesrequired|string|in:pending,in_progress,review

Example request

curl --request PATCH 'https://raqm-hr.com/api/employee/tasks/:id/status' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
    "status": "VALUE"
}'

Replace VALUE and :id with real values. The response varies by your account data and permissions.

POST /api/employee/tasks/{id}/submitTasksController · submit Bearer Subscription

POSThttps://raqm-hr.com/api/employee/tasks/{id}/submit

Controller: TasksController · submit

Parameters

NameInRequiredValidation / source

idPathYesRoute parameter

achievement_summaryBodyYesrequired|string

attachmentsBodyNonullable|array

statusBodyNoreview

Example request

curl --request POST 'https://raqm-hr.com/api/employee/tasks/:id/submit' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
    "achievement_summary": "VALUE",
    "attachments": "VALUE",
    "status": "VALUE"
}'

Replace VALUE and :id with real values. The response varies by your account data and permissions.

GET /api/employee/tasks/{taskId}/subtasksSubtasksController · index Bearer Subscription

GEThttps://raqm-hr.com/api/employee/tasks/{taskId}/subtasks

Controller: SubtasksController · index

Parameters

NameInRequiredValidation / source

taskIdPathYesRoute parameter

Example request

curl --request GET 'https://raqm-hr.com/api/employee/tasks/:taskId/subtasks' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN'

Replace VALUE and :id with real values. The response varies by your account data and permissions.

POST /api/employee/tasks/{taskId}/subtasksSubtasksController · store Bearer Subscription

POSThttps://raqm-hr.com/api/employee/tasks/{taskId}/subtasks

Controller: SubtasksController · store

Parameters

NameInRequiredValidation / source

taskIdPathYesRoute parameter

titleBodyYesrequired|string|max:255

descriptionBodyNonullable|string

statusBodyNonullable|in:new,in_progress,review,completed,cancelled

priorityBodyNonullable|in:low,medium,high,urgent

assigned_toBodyNonullable|exists:employees,id

employee_idsBodyNonullable|array

start_dateBodyNonullable|date

end_dateBodyNonullable|date

estimated_hoursBodyNonullable|numeric|min:0

Example request

curl --request POST 'https://raqm-hr.com/api/employee/tasks/:taskId/subtasks' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
    "title": "VALUE",
    "description": "VALUE",
    "status": "VALUE",
    "priority": "VALUE",
    "assigned_to": "VALUE",
    "employee_ids": "VALUE",
    "start_date": "YYYY-MM-DD",
    "end_date": "YYYY-MM-DD",
    "estimated_hours": 0
}'

Replace VALUE and :id with real values. The response varies by your account data and permissions.

GET /api/employee/timesheetsTimesheetController · index Bearer Subscription

GEThttps://raqm-hr.com/api/employee/timesheets

Controller: TimesheetController · index

Parameters

No parameters are declared by this route or its request validation.

Example request

curl --request GET 'https://raqm-hr.com/api/employee/timesheets' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN'

Replace VALUE and :id with real values. The response varies by your account data and permissions.

POST /api/employee/timesheetsTimesheetController · store Bearer Subscription

POSThttps://raqm-hr.com/api/employee/timesheets

Controller: TimesheetController · store

Parameters

NameInRequiredValidation / source

project_idBodyYesrequired|integer

project_task_idBodyYesrequired|integer

dateBodyYesrequired|date

hoursBodyYesrequired|numeric|min:0.25|max:24

descriptionBodyNonullable|string

is_billableBodyNonullable|boolean

statusBodyNonullable|in:draft,submitted

Example request

curl --request POST 'https://raqm-hr.com/api/employee/timesheets' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
    "project_id": 0,
    "project_task_id": 0,
    "date": "YYYY-MM-DD",
    "hours": 0,
    "description": "VALUE",
    "is_billable": true,
    "status": "VALUE"
}'

Replace VALUE and :id with real values. The response varies by your account data and permissions.

POST /api/employee/timesheets/submitTimesheetController · submit Bearer Subscription

POSThttps://raqm-hr.com/api/employee/timesheets/submit

Controller: TimesheetController · submit

Parameters

No parameters are declared by this route or its request validation.

Example request

curl --request POST 'https://raqm-hr.com/api/employee/timesheets/submit' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN'

Replace VALUE and :id with real values. The response varies by your account data and permissions.

GET /api/employee/timesheets/summaryTimesheetController · summary Bearer Subscription

GEThttps://raqm-hr.com/api/employee/timesheets/summary

Controller: TimesheetController · summary

Parameters

No parameters are declared by this route or its request validation.

Example request

curl --request GET 'https://raqm-hr.com/api/employee/timesheets/summary' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN'

Replace VALUE and :id with real values. The response varies by your account data and permissions.

PUT /api/employee/timesheets/{id}TimesheetController · update Bearer Subscription

PUThttps://raqm-hr.com/api/employee/timesheets/{id}

Controller: TimesheetController · update

Parameters

NameInRequiredValidation / source

idPathYesRoute parameter

dateBodyYessometimes|required|date

hoursBodyYessometimes|required|numeric|min:0.25|max:24

descriptionBodyNonullable|string

is_billableBodyNonullable|boolean

statusBodyNonullable|in:draft,submitted

Example request

curl --request PUT 'https://raqm-hr.com/api/employee/timesheets/:id' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
    "date": "YYYY-MM-DD",
    "hours": 0,
    "description": "VALUE",
    "is_billable": true,
    "status": "VALUE"
}'

Replace VALUE and :id with real values. The response varies by your account data and permissions.

DELETE /api/employee/timesheets/{id}TimesheetController · destroy Bearer Subscription

DELETEhttps://raqm-hr.com/api/employee/timesheets/{id}

Controller: TimesheetController · destroy

Parameters

NameInRequiredValidation / source

idPathYesRoute parameter

Example request

curl --request DELETE 'https://raqm-hr.com/api/employee/timesheets/:id' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN'

Replace VALUE and :id with real values. The response varies by your account data and permissions.

POST /api/employee/timesheets/{id}/submitTimesheetController · submit Bearer Subscription

POSThttps://raqm-hr.com/api/employee/timesheets/{id}/submit

Controller: TimesheetController · submit

Parameters

NameInRequiredValidation / source

idPathYesRoute parameter

Example request

curl --request POST 'https://raqm-hr.com/api/employee/timesheets/:id/submit' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN'

Replace VALUE and :id with real values. The response varies by your account data and permissions.

GET /api/employee/trainingTrainingController · index Bearer Subscription

GEThttps://raqm-hr.com/api/employee/training

Controller: TrainingController · index

Parameters

No parameters are declared by this route or its request validation.

Example request

curl --request GET 'https://raqm-hr.com/api/employee/training' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN'

Replace VALUE and :id with real values. The response varies by your account data and permissions.

GET /api/employee/training/{id}TrainingController · show Bearer Subscription

GEThttps://raqm-hr.com/api/employee/training/{id}

Controller: TrainingController · show

Parameters

NameInRequiredValidation / source

idPathYesRoute parameter

Example request

curl --request GET 'https://raqm-hr.com/api/employee/training/:id' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN'

Replace VALUE and :id with real values. The response varies by your account data and permissions.

GET /api/employee/upcoming-holidaysUpcomingHolidayController · index Bearer Subscription

GEThttps://raqm-hr.com/api/employee/upcoming-holidays

Controller: UpcomingHolidayController · index

Parameters

No parameters are declared by this route or its request validation.

Example request

curl --request GET 'https://raqm-hr.com/api/employee/upcoming-holidays' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN'

Replace VALUE and :id with real values. The response varies by your account data and permissions.

GET /api/employee/vacationsLeavesController · vacationSummary Bearer Subscription

GEThttps://raqm-hr.com/api/employee/vacations

Controller: LeavesController · vacationSummary

Parameters

No parameters are declared by this route or its request validation.

Example request

curl --request GET 'https://raqm-hr.com/api/employee/vacations' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN'

Replace VALUE and :id with real values. The response varies by your account data and permissions.

GET /api/employee/visasVisaController · index Bearer Subscription

GEThttps://raqm-hr.com/api/employee/visas

Controller: VisaController · index

Parameters

No parameters are declared by this route or its request validation.

Example request

curl --request GET 'https://raqm-hr.com/api/employee/visas' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN'

Replace VALUE and :id with real values. The response varies by your account data and permissions.

Meeting request

1 routes

POST /api/meeting-requestLandingController · bookMeeting Public

POSThttps://raqm-hr.com/api/meeting-request

Controller: LandingController · bookMeeting

Parameters

NameInRequiredValidation / source

company_nameBodyYesrequired|string|max:255

contact_nameBodyYesrequired|string|max:255

emailBodyYesrequired|email

phoneBodyYesrequired|string|max:30

preferred_dateBodyNonullable|date

preferred_timeBodyNonullable|date_format:H:i

notesBodyNonullable|string|max:1000

country_codeBodyNonullable|string|size:2

Example request

curl --request POST 'https://raqm-hr.com/api/meeting-request' \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{
    "company_name": "VALUE",
    "contact_name": "VALUE",
    "email": "VALUE",
    "phone": "VALUE",
    "preferred_date": "YYYY-MM-DD",
    "preferred_time": "YYYY-MM-DD",
    "notes": "VALUE",
    "country_code": "VALUE"
}'

Replace VALUE and :id with real values. The response varies by your account data and permissions.

Muqeem & residency

6 routes

GET /api/muqeem/exit-reentry/statusMuqeemController · exitReentryStatus Bearer

GEThttps://raqm-hr.com/api/muqeem/exit-reentry/status

Controller: MuqeemController · exitReentryStatus

Parameters

NameInRequiredValidation / source

visa_idBodyYesrequired|exists:exit_reentry_visas,id

Example request

curl --request GET 'https://raqm-hr.com/api/muqeem/exit-reentry/status' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN'

Replace VALUE and :id with real values. The response varies by your account data and permissions.

GET /api/muqeem/iqama/expiryMuqeemController · iqamaExpiry Bearer

GEThttps://raqm-hr.com/api/muqeem/iqama/expiry

Controller: MuqeemController · iqamaExpiry

Parameters

NameInRequiredValidation / source

employee_idBodyNonullable|exists:employees,id

messageBodyNoNo expiry date found

dataBodyNoiqama_number | expiry_date | Y-m-d | days_until_expiry | is_expired

Example request

curl --request GET 'https://raqm-hr.com/api/muqeem/iqama/expiry' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN'

Replace VALUE and :id with real values. The response varies by your account data and permissions.

GET /api/muqeem/iqama/statusMuqeemController · iqamaStatus Bearer

GEThttps://raqm-hr.com/api/muqeem/iqama/status

Controller: MuqeemController · iqamaStatus

Parameters

NameInRequiredValidation / source

employee_idBodyNonullable|exists:employees,id

messageBodyNoNo iqama record found

Example request

curl --request GET 'https://raqm-hr.com/api/muqeem/iqama/status' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN'

Replace VALUE and :id with real values. The response varies by your account data and permissions.

GET /api/muqeem/passport/infoMuqeemController · passportInfo Bearer

GEThttps://raqm-hr.com/api/muqeem/passport/info

Controller: MuqeemController · passportInfo

Parameters

NameInRequiredValidation / source

employee_idBodyNonullable|exists:employees,id

messageBodyNoNo passport record found

Example request

curl --request GET 'https://raqm-hr.com/api/muqeem/passport/info' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN'

Replace VALUE and :id with real values. The response varies by your account data and permissions.

POST /api/muqeem/reports/residentMuqeemController · residentReport Bearer

POSThttps://raqm-hr.com/api/muqeem/reports/resident

Controller: MuqeemController · residentReport

Parameters

NameInRequiredValidation / source

iqama_numberBodyYesrequired|string

messageBodyNoFailed to fetch report

Example request

curl --request POST 'https://raqm-hr.com/api/muqeem/reports/resident' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
    "iqama_number": "VALUE",
    "message": "VALUE"
}'

Replace VALUE and :id with real values. The response varies by your account data and permissions.

POST /api/muqeem/verify/residentMuqeemController · verifyResident Bearer

POSThttps://raqm-hr.com/api/muqeem/verify/resident

Controller: MuqeemController · verifyResident

Parameters

NameInRequiredValidation / source

iqama_numberBodyYesrequired|string

messageBodyNoVerification failed

Example request

curl --request POST 'https://raqm-hr.com/api/muqeem/verify/resident' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
    "iqama_number": "VALUE",
    "message": "VALUE"
}'

Replace VALUE and :id with real values. The response varies by your account data and permissions.

Occasion campaigns

1 routes

GET /api/occasion-campaignsOccasionCampaignController · publicIndex Public

GEThttps://raqm-hr.com/api/occasion-campaigns

Controller: OccasionCampaignController · publicIndex

Parameters

No parameters are declared by this route or its request validation.

Example request

curl --request GET 'https://raqm-hr.com/api/occasion-campaigns' \
  --header 'Accept: application/json'

Replace VALUE and :id with real values. The response varies by your account data and permissions.

Payroll

31 routes

GET /api/payroll-module/accountsPayrollModuleController · accounts Bearer

GEThttps://raqm-hr.com/api/payroll-module/accounts

Controller: PayrollModuleController · accounts

Parameters

No parameters are declared by this route or its request validation.

Example request

curl --request GET 'https://raqm-hr.com/api/payroll-module/accounts' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN'

Replace VALUE and :id with real values. The response varies by your account data and permissions.

POST /api/payroll-module/accountsPayrollModuleController · storeAccount Bearer

POSThttps://raqm-hr.com/api/payroll-module/accounts

Controller: PayrollModuleController · storeAccount

Parameters

NameInRequiredValidation / source

codeBodyYesrequired|string|max:20

nameBodyYesrequired|string|max:255

name_arBodyNonullable|string|max:255

account_typeBodyYesrequired|in:asset,liability,expense,revenue,equity

activeBodyNonullable|boolean

messageBodyNoتم إنشاء الحساب بنجاح

Example request

curl --request POST 'https://raqm-hr.com/api/payroll-module/accounts' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
    "code": "VALUE",
    "name": "VALUE",
    "name_ar": "VALUE",
    "account_type": "VALUE",
    "active": true,
    "message": "VALUE"
}'

Replace VALUE and :id with real values. The response varies by your account data and permissions.

PUT /api/payroll-module/accounts/{id}PayrollModuleController · updateAccount Bearer

PUThttps://raqm-hr.com/api/payroll-module/accounts/{id}

Controller: PayrollModuleController · updateAccount

Parameters

NameInRequiredValidation / source

idPathYesRoute parameter

codeBodyNosometimes|string|max:20

nameBodyNosometimes|string|max:255

name_arBodyNonullable|string|max:255

account_typeBodyNosometimes|in:asset,liability,expense,revenue,equity

activeBodyNonullable|boolean

messageBodyNoتم تحديث الحساب

Example request

curl --request PUT 'https://raqm-hr.com/api/payroll-module/accounts/:id' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
    "code": "VALUE",
    "name": "VALUE",
    "name_ar": "VALUE",
    "account_type": "VALUE",
    "active": true,
    "message": "VALUE"
}'

Replace VALUE and :id with real values. The response varies by your account data and permissions.

DELETE /api/payroll-module/accounts/{id}PayrollModuleController · destroyAccount Bearer

DELETEhttps://raqm-hr.com/api/payroll-module/accounts/{id}

Controller: PayrollModuleController · destroyAccount

Parameters

NameInRequiredValidation / source

idPathYesRoute parameter

messageBodyNoتم حذف الحساب

Example request

curl --request DELETE 'https://raqm-hr.com/api/payroll-module/accounts/:id' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN'

Replace VALUE and :id with real values. The response varies by your account data and permissions.

GET /api/payroll-module/contractsPayrollModuleController · contracts Bearer

GEThttps://raqm-hr.com/api/payroll-module/contracts

Controller: PayrollModuleController · contracts

Parameters

No parameters are declared by this route or its request validation.

Example request

curl --request GET 'https://raqm-hr.com/api/payroll-module/contracts' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN'

Replace VALUE and :id with real values. The response varies by your account data and permissions.

POST /api/payroll-module/contractsPayrollModuleController · storeContract Bearer

POSThttps://raqm-hr.com/api/payroll-module/contracts

Controller: PayrollModuleController · storeContract

Parameters

NameInRequiredValidation / source

employee_idBodyYesrequired|exists:employees,id

structure_idBodyYesrequired|exists:payroll_structures,id

nameBodyNonullable|string|max:255

wageBodyYesrequired|numeric|min:0

date_startBodyYesrequired|date

date_endBodyNonullable|date|after_or_equal:date_start

stateBodyNonullable|in:draft,open,close

notesBodyNonullable|string

messageBodyNoتم إنشاء العقد بنجاح

Example request

curl --request POST 'https://raqm-hr.com/api/payroll-module/contracts' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
    "employee_id": "VALUE",
    "structure_id": "VALUE",
    "name": "VALUE",
    "wage": 0,
    "date_start": "YYYY-MM-DD",
    "date_end": "YYYY-MM-DD",
    "state": "VALUE",
    "notes": "VALUE",
    "message": "VALUE"
}'

Replace VALUE and :id with real values. The response varies by your account data and permissions.

GET /api/payroll-module/contracts/{id}PayrollModuleController · showContract Bearer

GEThttps://raqm-hr.com/api/payroll-module/contracts/{id}

Controller: PayrollModuleController · showContract

Parameters

NameInRequiredValidation / source

idPathYesRoute parameter

Example request

curl --request GET 'https://raqm-hr.com/api/payroll-module/contracts/:id' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN'

Replace VALUE and :id with real values. The response varies by your account data and permissions.

PUT /api/payroll-module/contracts/{id}PayrollModuleController · updateContract Bearer

PUThttps://raqm-hr.com/api/payroll-module/contracts/{id}

Controller: PayrollModuleController · updateContract

Parameters

NameInRequiredValidation / source

idPathYesRoute parameter

structure_idBodyNosometimes|exists:payroll_structures,id

nameBodyNonullable|string|max:255

wageBodyNosometimes|numeric|min:0

date_startBodyNosometimes|date

date_endBodyNonullable|date

stateBodyNosometimes|in:draft,open,close

notesBodyNonullable|string

messageBodyNoتم تحديث العقد

Example request

curl --request PUT 'https://raqm-hr.com/api/payroll-module/contracts/:id' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
    "structure_id": "VALUE",
    "name": "VALUE",
    "wage": 0,
    "date_start": "YYYY-MM-DD",
    "date_end": "YYYY-MM-DD",
    "state": "VALUE",
    "notes": "VALUE",
    "message": "VALUE"
}'

Replace VALUE and :id with real values. The response varies by your account data and permissions.

DELETE /api/payroll-module/contracts/{id}PayrollModuleController · destroyContract Bearer

DELETEhttps://raqm-hr.com/api/payroll-module/contracts/{id}

Controller: PayrollModuleController · destroyContract

Parameters

NameInRequiredValidation / source

idPathYesRoute parameter

messageBodyNoتم حذف العقد

Example request

curl --request DELETE 'https://raqm-hr.com/api/payroll-module/contracts/:id' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN'

Replace VALUE and :id with real values. The response varies by your account data and permissions.

POST /api/payroll-module/payslip/computePayrollModuleController · computePayslip Bearer

POSThttps://raqm-hr.com/api/payroll-module/payslip/compute

Controller: PayrollModuleController · computePayslip

Parameters

NameInRequiredValidation / source

employee_idBodyYesrequired|exists:employees,id

yearBodyYesrequired|integer|min:2020|max:2040

monthBodyYesrequired|integer|min:1|max:12

saveBodyNonullable|boolean

Example request

curl --request POST 'https://raqm-hr.com/api/payroll-module/payslip/compute' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
    "employee_id": "VALUE",
    "year": 0,
    "month": 0,
    "save": true
}'

Replace VALUE and :id with real values. The response varies by your account data and permissions.

POST /api/payroll-module/payslip/compute-bulkPayrollModuleController · computeBulk Bearer

POSThttps://raqm-hr.com/api/payroll-module/payslip/compute-bulk

Controller: PayrollModuleController · computeBulk

Parameters

NameInRequiredValidation / source

yearBodyYesrequired|integer|min:2020|max:2040

monthBodyYesrequired|integer|min:1|max:12

employee_idsBodyNonullable|array

messageBodyNoتم حساب {$results[

Example request

curl --request POST 'https://raqm-hr.com/api/payroll-module/payslip/compute-bulk' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
    "year": 0,
    "month": 0,
    "employee_ids": "VALUE",
    "message": "VALUE"
}'

Replace VALUE and :id with real values. The response varies by your account data and permissions.

GET /api/payroll-module/payslip/{employee_id}/{year}/{month}PayrollModuleController · getPayslip Bearer

GEThttps://raqm-hr.com/api/payroll-module/payslip/{employee_id}/{year}/{month}

Controller: PayrollModuleController · getPayslip

Parameters

NameInRequiredValidation / source

employee_idPathYesRoute parameter

yearPathYesRoute parameter

monthPathYesRoute parameter

Example request

curl --request GET 'https://raqm-hr.com/api/payroll-module/payslip/:employee_id/:year/:month' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN'

Replace VALUE and :id with real values. The response varies by your account data and permissions.

DELETE /api/payroll-module/payslip/{id}PayrollModuleController · destroyPayslip Bearer

DELETEhttps://raqm-hr.com/api/payroll-module/payslip/{id}

Controller: PayrollModuleController · destroyPayslip

Parameters

NameInRequiredValidation / source

idPathYesRoute parameter

messageBodyNoتم حذف إيصال الراتب

Example request

curl --request DELETE 'https://raqm-hr.com/api/payroll-module/payslip/:id' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN'

Replace VALUE and :id with real values. The response varies by your account data and permissions.

POST /api/payroll-module/payslip/{id}/confirmPayrollModuleController · confirmPayslip Bearer

POSThttps://raqm-hr.com/api/payroll-module/payslip/{id}/confirm

Controller: PayrollModuleController · confirmPayslip

Parameters

NameInRequiredValidation / source

idPathYesRoute parameter

messageBodyNoتم اعتماد إيصال الراتب

stateBodyNoconfirmed

Example request

curl --request POST 'https://raqm-hr.com/api/payroll-module/payslip/:id/confirm' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
    "message": "VALUE",
    "state": "VALUE"
}'

Replace VALUE and :id with real values. The response varies by your account data and permissions.

GET /api/payroll-module/payslip/{id}/journal-entriesPayrollModuleController · journalEntries Bearer

GEThttps://raqm-hr.com/api/payroll-module/payslip/{id}/journal-entries

Controller: PayrollModuleController · journalEntries

Parameters

NameInRequiredValidation / source

idPathYesRoute parameter

Example request

curl --request GET 'https://raqm-hr.com/api/payroll-module/payslip/:id/journal-entries' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN'

Replace VALUE and :id with real values. The response varies by your account data and permissions.

POST /api/payroll-module/payslip/{id}/payPayrollModuleController · payPayslip Bearer

POSThttps://raqm-hr.com/api/payroll-module/payslip/{id}/pay

Controller: PayrollModuleController · payPayslip

Parameters

NameInRequiredValidation / source

idPathYesRoute parameter

messageBodyNoتم تسجيل الإيصال كمدفوع

stateBodyNopaid

Example request

curl --request POST 'https://raqm-hr.com/api/payroll-module/payslip/:id/pay' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
    "message": "VALUE",
    "state": "VALUE"
}'

Replace VALUE and :id with real values. The response varies by your account data and permissions.

GET /api/payroll-module/payslipsPayrollModuleController · payslips Bearer

GEThttps://raqm-hr.com/api/payroll-module/payslips

Controller: PayrollModuleController · payslips

Parameters

No parameters are declared by this route or its request validation.

Example request

curl --request GET 'https://raqm-hr.com/api/payroll-module/payslips' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN'

Replace VALUE and :id with real values. The response varies by your account data and permissions.

GET /api/payroll-module/rule-categoriesPayrollModuleController · ruleCategories Bearer

GEThttps://raqm-hr.com/api/payroll-module/rule-categories

Controller: PayrollModuleController · ruleCategories

Parameters

No parameters are declared by this route or its request validation.

Example request

curl --request GET 'https://raqm-hr.com/api/payroll-module/rule-categories' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN'

Replace VALUE and :id with real values. The response varies by your account data and permissions.

POST /api/payroll-module/rule-categoriesPayrollModuleController · storeRuleCategory Bearer

POSThttps://raqm-hr.com/api/payroll-module/rule-categories

Controller: PayrollModuleController · storeRuleCategory

Parameters

NameInRequiredValidation / source

nameBodyYesrequired|string|max:255

name_arBodyNonullable|string|max:255

codeBodyYesrequired|string|max:20

messageBodyNoتم إنشاء تصنيف القاعدة بنجاح

Example request

curl --request POST 'https://raqm-hr.com/api/payroll-module/rule-categories' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
    "name": "VALUE",
    "name_ar": "VALUE",
    "code": "VALUE",
    "message": "VALUE"
}'

Replace VALUE and :id with real values. The response varies by your account data and permissions.

PUT /api/payroll-module/rule-categories/{id}PayrollModuleController · updateRuleCategory Bearer

PUThttps://raqm-hr.com/api/payroll-module/rule-categories/{id}

Controller: PayrollModuleController · updateRuleCategory

Parameters

NameInRequiredValidation / source

idPathYesRoute parameter

nameBodyNosometimes|string|max:255

name_arBodyNonullable|string|max:255

codeBodyNosometimes|string|max:20

messageBodyNoتم تحديث تصنيف القاعدة

Example request

curl --request PUT 'https://raqm-hr.com/api/payroll-module/rule-categories/:id' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
    "name": "VALUE",
    "name_ar": "VALUE",
    "code": "VALUE",
    "message": "VALUE"
}'

Replace VALUE and :id with real values. The response varies by your account data and permissions.

DELETE /api/payroll-module/rule-categories/{id}PayrollModuleController · destroyRuleCategory Bearer

DELETEhttps://raqm-hr.com/api/payroll-module/rule-categories/{id}

Controller: PayrollModuleController · destroyRuleCategory

Parameters

NameInRequiredValidation / source

idPathYesRoute parameter

messageBodyNoتم حذف التصنيف

Example request

curl --request DELETE 'https://raqm-hr.com/api/payroll-module/rule-categories/:id' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN'

Replace VALUE and :id with real values. The response varies by your account data and permissions.

GET /api/payroll-module/rulesPayrollModuleController · rules Bearer

GEThttps://raqm-hr.com/api/payroll-module/rules

Controller: PayrollModuleController · rules

Parameters

No parameters are declared by this route or its request validation.

Example request

curl --request GET 'https://raqm-hr.com/api/payroll-module/rules' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN'

Replace VALUE and :id with real values. The response varies by your account data and permissions.

POST /api/payroll-module/rulesPayrollModuleController · storeRule Bearer

POSThttps://raqm-hr.com/api/payroll-module/rules

Controller: PayrollModuleController · storeRule

Parameters

NameInRequiredValidation / source

structure_idBodyYesrequired|exists:payroll_structures,id

category_idBodyYesrequired|exists:payroll_rule_categories,id

nameBodyYesrequired|string|max:255

name_arBodyNonullable|string|max:255

codeBodyYesrequired|string|max:30

sequenceBodyYesrequired|integer|min:1

amount_typeBodyYesrequired|in:fixed,percentage,code

amount_fixedBodyNonullable|numeric

amount_percentageBodyNonullable|numeric|min:0|max:100

percentage_based_onBodyNonullable|string|max:30

amount_codeBodyNonullable|string

debit_account_idBodyNonullable|exists:chart_of_accounts,id

credit_account_idBodyNonullable|exists:chart_of_accounts,id

appears_on_payslipBodyNonullable|boolean

activeBodyNonullable|boolean

messageBodyNoتم إنشاء قاعدة الراتب بنجاح

Example request

curl --request POST 'https://raqm-hr.com/api/payroll-module/rules' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
    "structure_id": "VALUE",
    "category_id": "VALUE",
    "name": "VALUE",
    "name_ar": "VALUE",
    "code": "VALUE",
    "sequence": 0,
    "amount_type": "VALUE",
    "amount_fixed": 0,
    "amount_percentage": 0,
    "percentage_based_on": "VALUE",
    "amount_code": "VALUE",
    "debit_account_id": "VALUE",
    "credit_account_id": "VALUE",
    "appears_on_payslip": true,
    "active": true,
    "message": "VALUE"
}'

Replace VALUE and :id with real values. The response varies by your account data and permissions.

GET /api/payroll-module/rules/{id}PayrollModuleController · showRule Bearer

GEThttps://raqm-hr.com/api/payroll-module/rules/{id}

Controller: PayrollModuleController · showRule

Parameters

NameInRequiredValidation / source

idPathYesRoute parameter

Example request

curl --request GET 'https://raqm-hr.com/api/payroll-module/rules/:id' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN'

Replace VALUE and :id with real values. The response varies by your account data and permissions.

PUT /api/payroll-module/rules/{id}PayrollModuleController · updateRule Bearer

PUThttps://raqm-hr.com/api/payroll-module/rules/{id}

Controller: PayrollModuleController · updateRule

Parameters

NameInRequiredValidation / source

idPathYesRoute parameter

category_idBodyNosometimes|exists:payroll_rule_categories,id

nameBodyNosometimes|string|max:255

name_arBodyNonullable|string|max:255

codeBodyNosometimes|string|max:30

sequenceBodyNosometimes|integer|min:1

amount_typeBodyNosometimes|in:fixed,percentage,code

amount_fixedBodyNonullable|numeric

amount_percentageBodyNonullable|numeric|min:0|max:100

percentage_based_onBodyNonullable|string|max:30

amount_codeBodyNonullable|string

debit_account_idBodyNonullable|exists:chart_of_accounts,id

credit_account_idBodyNonullable|exists:chart_of_accounts,id

appears_on_payslipBodyNonullable|boolean

activeBodyNonullable|boolean

messageBodyNoتم تحديث قاعدة الراتب

Example request

curl --request PUT 'https://raqm-hr.com/api/payroll-module/rules/:id' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
    "category_id": "VALUE",
    "name": "VALUE",
    "name_ar": "VALUE",
    "code": "VALUE",
    "sequence": 0,
    "amount_type": "VALUE",
    "amount_fixed": 0,
    "amount_percentage": 0,
    "percentage_based_on": "VALUE",
    "amount_code": "VALUE",
    "debit_account_id": "VALUE",
    "credit_account_id": "VALUE",
    "appears_on_payslip": true,
    "active": true,
    "message": "VALUE"
}'

Replace VALUE and :id with real values. The response varies by your account data and permissions.

DELETE /api/payroll-module/rules/{id}PayrollModuleController · destroyRule Bearer

DELETEhttps://raqm-hr.com/api/payroll-module/rules/{id}

Controller: PayrollModuleController · destroyRule

Parameters

NameInRequiredValidation / source

idPathYesRoute parameter

messageBodyNoتم حذف قاعدة الراتب

Example request

curl --request DELETE 'https://raqm-hr.com/api/payroll-module/rules/:id' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN'

Replace VALUE and :id with real values. The response varies by your account data and permissions.

GET /api/payroll-module/structuresPayrollModuleController · structures Bearer

GEThttps://raqm-hr.com/api/payroll-module/structures

Controller: PayrollModuleController · structures

Parameters

No parameters are declared by this route or its request validation.

Example request

curl --request GET 'https://raqm-hr.com/api/payroll-module/structures' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN'

Replace VALUE and :id with real values. The response varies by your account data and permissions.

POST /api/payroll-module/structuresPayrollModuleController · storeStructure Bearer

POSThttps://raqm-hr.com/api/payroll-module/structures

Controller: PayrollModuleController · storeStructure

Parameters

NameInRequiredValidation / source

nameBodyYesrequired|string|max:255

name_arBodyNonullable|string|max:255

department_idBodyNonullable|exists:departments,id

activeBodyNonullable|boolean

messageBodyNoتم إنشاء هيكل الرواتب بنجاح

Example request

curl --request POST 'https://raqm-hr.com/api/payroll-module/structures' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
    "name": "VALUE",
    "name_ar": "VALUE",
    "department_id": "VALUE",
    "active": true,
    "message": "VALUE"
}'

Replace VALUE and :id with real values. The response varies by your account data and permissions.

GET /api/payroll-module/structures/{id}PayrollModuleController · showStructure Bearer

GEThttps://raqm-hr.com/api/payroll-module/structures/{id}

Controller: PayrollModuleController · showStructure

Parameters

NameInRequiredValidation / source

idPathYesRoute parameter

Example request

curl --request GET 'https://raqm-hr.com/api/payroll-module/structures/:id' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN'

Replace VALUE and :id with real values. The response varies by your account data and permissions.

PUT /api/payroll-module/structures/{id}PayrollModuleController · updateStructure Bearer

PUThttps://raqm-hr.com/api/payroll-module/structures/{id}

Controller: PayrollModuleController · updateStructure

Parameters

NameInRequiredValidation / source

idPathYesRoute parameter

nameBodyNosometimes|string|max:255

name_arBodyNonullable|string|max:255

department_idBodyNonullable|exists:departments,id

activeBodyNonullable|boolean

messageBodyNoتم تحديث هيكل الرواتب بنجاح

Example request

curl --request PUT 'https://raqm-hr.com/api/payroll-module/structures/:id' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
    "name": "VALUE",
    "name_ar": "VALUE",
    "department_id": "VALUE",
    "active": true,
    "message": "VALUE"
}'

Replace VALUE and :id with real values. The response varies by your account data and permissions.

DELETE /api/payroll-module/structures/{id}PayrollModuleController · destroyStructure Bearer

DELETEhttps://raqm-hr.com/api/payroll-module/structures/{id}

Controller: PayrollModuleController · destroyStructure

Parameters

NameInRequiredValidation / source

idPathYesRoute parameter

messageBodyNoتم حذف هيكل الرواتب

Example request

curl --request DELETE 'https://raqm-hr.com/api/payroll-module/structures/:id' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN'

Replace VALUE and :id with real values. The response varies by your account data and permissions.

User

1 routes

GET /api/userInternal handler Bearer

GEThttps://raqm-hr.com/api/user

Controller: Internal handler

Parameters

No parameters are declared by this route or its request validation.

Example request

curl --request GET 'https://raqm-hr.com/api/user' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN'

Replace VALUE and :id with real values. The response varies by your account data and permissions.

همّتكم تبني... وإحنا نأتمت الباقي

Raqm HR API documentation

Before you start

Attendance devices

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Employee mobile API

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters