HRMS · Services and actions
Payroll tax
The payroll tax service of HRMS: 14 operation(s).
/api/hrms/payroll-taxOverview
| 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 › Payroll tax 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
14 operations. Open one for its parameters, bodies, responses and a sample request.
GET/api/hrms/payroll-tax/packsPacks
Response
200 with the data as JSON.
Sample request
curl "https://demo.tranxact.ai/api/hrms/payroll-tax/packs" \
-H "Authorization: Bearer $TOKEN"GET/api/hrms/payroll-tax/packs/{code}/stepsPacks steps
Path parameters
| Name | Type | Description |
|---|---|---|
code | string (uuid) | The record's code, as a list returns it. |
Response
200 with the data as JSON.
Sample request
curl "https://demo.tranxact.ai/api/hrms/payroll-tax/packs/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/steps" \
-H "Authorization: Bearer $TOKEN"POST/api/hrms/payroll-tax/startStart
Request body
The keys this action reads (* = required; "one of" lists the only values):
packCode*, periodDate, periodKind; periodKind one of weekly|biweekly|semi_monthly|monthly|quarterly|semi_annual|annual|customResponse
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/payroll-tax/start" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"packCode":"value","periodDate":"value","periodKind;":"value"}'GET/api/hrms/payroll-tax/runs/{id}/detailRuns detail
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
Response
200 with the data as JSON.
Sample request
curl "https://demo.tranxact.ai/api/hrms/payroll-tax/runs/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/detail" \
-H "Authorization: Bearer $TOKEN"POST/api/hrms/payroll-tax/runs/{id}/steps/{key}/runRuns steps run
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
key | string (uuid) | The record's key, as a list returns it. |
No body is required.
Response
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/payroll-tax/runs/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/steps/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/run" \
-H "Authorization: Bearer $TOKEN"POST/api/hrms/payroll-tax/runs/{id}/steps/{key}/completeRuns steps complete
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
key | string (uuid) | The record's key, as a list returns it. |
Request body
The keys this action reads (* = required; "one of" lists the only values):
noteResponse
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/payroll-tax/runs/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/steps/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/complete" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"note":"value"}'POST/api/hrms/payroll-tax/runs/{id}/steps/{key}/skipRuns steps skip
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
key | string (uuid) | The record's key, as a list returns it. |
Request body
The keys this action reads (* = required; "one of" lists the only values):
reason*Response
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/payroll-tax/runs/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/steps/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/skip" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"reason":"value"}'POST/api/hrms/payroll-tax/runs/{id}/steps/{key}/approveRuns steps approve
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
key | string (uuid) | The record's key, as a list returns it. |
No body is required.
Response
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/payroll-tax/runs/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/steps/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/approve" \
-H "Authorization: Bearer $TOKEN"POST/api/hrms/payroll-tax/runs/{id}/approveRuns approve
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
No body is required.
Response
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/payroll-tax/runs/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/approve" \
-H "Authorization: Bearer $TOKEN"POST/api/hrms/payroll-tax/runs/{id}/depositRuns deposit
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
Request body
The keys this action reads (* = required; "one of" lists the only values):
depositDate, deposit_date, method, reference; method one of bank|portal|api|cheque|cash|challan|sadad|otherResponse
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/payroll-tax/runs/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/deposit" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"depositDate":"value","deposit_date":"value","method":"value","reference;":"value"}'POST/api/hrms/payroll-tax/runs/{id}/fileRuns file
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
Request body
The keys this action reads (* = required; "one of" lists the only values):
referenceResponse
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/payroll-tax/runs/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/file" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"reference":"value"}'POST/api/hrms/payroll-tax/calendar/generateCalendar generate
Request body
The keys this action reads (* = required; "one of" lists the only values):
monthsResponse
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/payroll-tax/calendar/generate" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"months":"value"}'GET/api/hrms/payroll-tax/calendarCalendar
Response
200 with the data as JSON.
Sample request
curl "https://demo.tranxact.ai/api/hrms/payroll-tax/calendar" \
-H "Authorization: Bearer $TOKEN"GET/api/hrms/payroll-tax/overviewOverview
Response
200 with the data as JSON.
Sample request
curl "https://demo.tranxact.ai/api/hrms/payroll-tax/overview" \
-H "Authorization: Bearer $TOKEN"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 › Payroll tax 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.