HRMS · Saudi Payroll
WPS Salary File
The salary information file for an approved payroll run, for the bank to pay and Mudad to record. Each employee’s iqama or ID, bank and IBAN, and the pay split into basic, housing, other earnings and deductions.
Type REST2 operationsBase path
/api/hrms/wps-salary-fileDownload specification (OpenAPI 3.1) Screen: WPS Salary File
Overview
| Package | HRMS |
|---|---|
| Authentication | Bearer token: a service account's token (POST /api/auth/service-token) or, for the published path, an API key |
| Authorization | The caller's roles must hold HRMS › WPS Salary File on the Roles screen: display for GET, add for POST, change for PUT, delete for DELETE; an action needs the grant of the button that runs it on the screen. |
| Rules | The same as the screen: validation, numbering, approvals, posting, the company the caller belongs to, and the audit trail. |
API reference
2 operations. Open one for its parameters, bodies, responses and a sample request.
GET/api/hrms/wps-salary-fileRead wps salary file
Response
200 with the data as JSON.
Sample request
curl "https://demo.tranxact.ai/api/hrms/wps-salary-file" \
-H "Authorization: Bearer $TOKEN"POST/api/hrms/wps-salary-filePost wps salary file
Request body
The keys this action reads (* = required; "one of" lists the only values):
runId, valueDateResponse
200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.
Sample request
curl -X POST "https://demo.tranxact.ai/api/hrms/wps-salary-file" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"runId":"value","valueDate":"value"}'Errors
| Status | Meaning |
|---|---|
| 400 | The request could not be read: a filter that is not JSON, a bad parameter |
| 401 | No credential, or it is wrong, revoked or expired |
| 403 | The caller's roles do not hold HRMS › WPS Salary File for this verb, or the address or origin is not allowed |
| 404 | No record with that id is visible to the caller |
| 409 | A conflict: a duplicate number, a document in a state that does not allow it, or a record changed or locked by someone else |
| 422 | Refused by the same validation as the screen; the error names the field and why |
Every error is JSON: {"error": "a sentence saying what was wrong"}, with field where it applies.