API Error Codes List

When running an API function, IF any error occurs, the following message format will be received: 
{
  "ResponseCode": 7,
  "ResponseMsgEng": "Please fill up the required fields."
}
This page provides a comprehensive list of all possible Response Codes and their corresponding HTTP status codes.

Response Code HTTP Code Message in English
0 200 Success. This is the standard code indicating the function executed correctly.
1 200 Incomplete success. Something is missing, read the message text ("ResponseMsgEng").
2 200 No Results / Data.
Note: The function executed successfully, but no records were found.

Common Error Messages:
3 404 API function does not exist.
4 500 Database error on the server side.
5 500 Technical error on the server side.
OR
You have reached the limit of "parallel tenants" (crm entities).
6 401 Wrong account credentials (Unauthorized).
7 400 Please fill up the required fields.
8 403 You are NOT authorized to access this data or function.
9 400 Please fill in the fields in the Acceptable Languages. +[Acceptable Language List]
11 422 Security Alert: + [Description].
12 422 This entity is already locked by another user.
13 400 The new password must be at least 8 characters long and contain 2 digits and 3 letters.
When using English ONLY, it is mandatory to combine uppercase and lowercase letters.
14 400 Posted fields contain wrong data and/or missing fields.

Documents Module Error Messages:
15 400 Missing parameter "Folder_Uid" (positive integer) for the Prototype folder ID.
16 400 You cannot upload files with an extension other than: JPG, JPEG, PNG, PDF, TIF/f, DOC/x, XLS/x.
17 400 You cannot upload files larger than 50 Megabytes.
18 422 You cannot delete this file + [FileName]

Entities Related Error Messages:
20 404 Account does not exist in Hyper.
21 404 Client does not exist in Hyper.
22 404 Supplier does not exist in Hyper.
23 404 Project does not exist in Hyper.
24 500 No answer from the Index module.
Check that Hyper's "Server Side App" is up and running, The index module contained in it.
25 422 Email address is not valid: + [Address]
26 422 Phone number is not valid: + [phone]
27 422 Registration is allowed for people aged [Minimum Age] and over.
28 400 The new password must be at least 8 characters long and contain 2 digits and 3 letters.
When using English ONLY, it is mandatory to combine uppercase and lowercase letters.
29 422 The ID Number failed the control digit test.
30 400 A form with identical information has already been submitted (Duplicate post).
31 400 Client has already registered previously with different details. (like same ID number with different Email or Phone)
32 400 This case (ticket) is closed. You cannot update it anymore.

Payments Related Error Messages:
40 400 Payments Gateway does not exist or is disabled.
41 503 Error on Payments Gateway Initialization.
50 503 You can run only one journal request at a time for a specific account.

HTTP response code

All Success responses and some of the errors will return under
HTTP 200 OK
.
The rest will return under HTTP error codes, here are some examples: 

HTTP/1.1 200 OK
HTTP/1.1 400 Bad Request
HTTP/1.1 401 Unauthorized
HTTP/1.1 403 Forbidden
HTTP/1.1 404 Not Found
HTTP/1.1 406 Not Acceptable
HTTP/1.1 416 Range Not Satisfiable
HTTP/1.1 422 Unprocessable Entity
HTTP/1.1 500 Internal Server Error
HTTP/1.1 501 Not Implemented
HTTP/1.1 503 Service Unavailable