TRANXACT.AI Help

HRMS · Tax & Filing

Statutory Forms

The statutory payroll forms of the company’s country, and where each one is prepared.

Type REST8 operationsBase path /api/hrms/tax-forms

Download specification (OpenAPI 3.1) Screen: Statutory Forms

Overview

PackageHRMS
AuthenticationBearer token: a service account's token (POST /api/auth/service-token) or, for the published path, an API key
AuthorizationThe caller's roles must hold HRMS › Statutory Forms 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.
RulesThe same as the screen: validation, numbering, approvals, posting, the company the caller belongs to, and the audit trail.

API reference

8 operations. Open one for its parameters, bodies, responses and a sample request.

GET/api/hrms/tax-formsRead statutory forms

Response

200 with the data as JSON.

Sample request

curl "https://demo.tranxact.ai/api/hrms/tax-forms" \
  -H "Authorization: Bearer $TOKEN"
POST/api/hrms/tax-forms/generateGenerate

Request body

The keys this action reads (* = required; "one of" lists the only values):

formCode*, taxYear, quarter, employeeId, supplierId, allEmployees

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/tax-forms/generate" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"formCode":"value","taxYear":"value","quarter":"value","employeeId":"value","supplierId":"value","allEmployees":"value"}'
GET/api/hrms/tax-forms/{id}Read statutory forms

Path parameters

NameTypeDescription
idstring (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/tax-forms/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
PUT/api/hrms/tax-forms/{id}/boxes/{boxNo}Boxes

Path parameters

NameTypeDescription
idstring (uuid)The record's id, as a list returns it.
boxNostring (uuid)The record's boxNo, as a list returns it.

Request body

The keys this action reads (* = required; "one of" lists the only values):

value, 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 PUT "https://demo.tranxact.ai/api/hrms/tax-forms/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/boxes/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"value":"value","reason":"value"}'
POST/api/hrms/tax-forms/{id}/approveApprove

Path parameters

NameTypeDescription
idstring (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/tax-forms/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/approve" \
  -H "Authorization: Bearer $TOKEN"
POST/api/hrms/tax-forms/{id}/fileFile

Path parameters

NameTypeDescription
idstring (uuid)The record's id, as a list returns it.

Request body

The keys this action reads (* = required; "one of" lists the only values):

method, reference

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/tax-forms/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/file" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"method":"value","reference":"value"}'
POST/api/hrms/tax-forms/{id}/correctCorrect

Path parameters

NameTypeDescription
idstring (uuid)The record's id, 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/tax-forms/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/correct" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"reason":"value"}'
GET/api/hrms/tax-forms/{id}/exportExport

Path parameters

NameTypeDescription
idstring (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/tax-forms/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/export" \
  -H "Authorization: Bearer $TOKEN"

Errors

StatusMeaning
400The request could not be read: a filter that is not JSON, a bad parameter
401No credential, or it is wrong, revoked or expired
403The caller's roles do not hold HRMS › Statutory Forms for this verb, or the address or origin is not allowed
404No record with that id is visible to the caller
409A conflict: a duplicate number, a document in a state that does not allow it, or a record changed or locked by someone else
422Refused 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.