Errors

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 name	attribute type	attribute description
code	string	Error code
message	string	Error message
object_type	string	Indication of the object type that triggered the error
object_id	string	Object reference - id of the object that triggered the error

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

JSON

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