Symmetrical Payroll API uses standard HTTP response codes: 2xx, 4xx. In addition 5xx errors indicate server error we will work to fix immediately.

Error structure conform to the following schema:

attribute nameattribute typeattribute description
codestringError code
messagestringError message
object_typestringIndication of the object type that triggered the error
object_idstringObject reference - id of the object that triggered the error

An example error message in the response body may look like this:

  "error": {
    "code": "incorrect_action",
    "message": "accept action must follow the approve action",
    "object_type": "payroll_calculation",
    "object_id": "455be7bd-0540-4250-91b8-d29117fdba2c"