{
"info": {
"_postman_id": "db328ac7-2bb6-4037-b87f-76344cb34960",
"name": "Average Salary Certificate",
"description": "\n### This API aims to provide a certificate average salary of a government Employee
\n#### To see the error messages and the valid response :\n | Response Status Code | National Number | Id Type | Birth Date | Date Type | Required Month |\n | ---------------------| ----------------| --------|-------------------------|--------------------|----------------|\n | **200** | 1000000000 | 1 |1989-08-12 |Gregorian | 3 |\n | **200** | 2000000000 | 2 |1979-12-06 |Gregorian | 6 |\n | **200** | 1000000001 | 1 |2000-01-10 |Gregorian | 3 |\n | **200** | 1000000002 | 1 |1978-11-08 |Gregorian | 6 |\n | **200** | 1000000017 | 3 |1990-04-01 or 1410-06-06 |Gregorian or Hijri | 3 |\n | **400** | 1000000006 | 2 |1978-11-08 |Gregorian | 6 |\n | **400** | 1000000008 | 1 |1980-01-14 |Gregorian | 6 |\n | **500** | 1000000018 | 1 |1993-01-21 or 1413-07-28 |Gregorian or Hijri | 6 |\n\n\n\n **More information about authorization can be found in the Token API integration guide:**\n",
"schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json",
"_exporter_id": "47100298",
"_collection_link": "https://rehamalmutiri-4180031.postman.co/workspace/15944b1e-b16d-4441-8b30-4304c956348c/collection/47100298-db328ac7-2bb6-4037-b87f-76344cb34960?action=share&source=collection_link&creator=47100298"
},
"item": [
{
"name": "sandbox",
"item": [
{
"name": "average",
"item": [
{
"name": "v1",
"item": [
{
"name": "employees",
"item": [
{
"name": "{personalIdNum}",
"item": [
{
"name": "payslips",
"item": [
{
"name": "/sandbox/average/v1/employees/:personalIdNum/payslips",
"request": {
"auth": {
"type": "oauth2",
"oauth2": [
{
"key": "clientSecret",
"value": "{{clientSecret}}",
"type": "string"
},
{
"key": "clientId",
"value": "{{clientID}}",
"type": "string"
},
{
"key": "scope",
"value": "ReadAverageSalaryCertificate",
"type": "string"
},
{
"key": "accessTokenUrl",
"value": "{{baseUrl}}/sandbox/oauth/v2/accesstoken",
"type": "string"
},
{
"key": "grant_type",
"value": "client_credentials",
"type": "string"
}
]
},
"method": "GET",
"header": [
{
"key": "X_MOF_RqUID",
"value": "{{$guid}}",
"description": "(Required) Unique reference, GUID format"
},
{
"key": "X_MOF_ClientID",
"value": "{{clientID}}",
"description": "(Required) Client Id of Banks or fintech companies"
},
{
"key": "X_EXT_RequestReason",
"value": "card",
"description": "(Required) Consumer must to say the reason of this inquiry"
},
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/sandbox/average/v1/employees/:personalIdNum/payslips?birthDate=1989-08-12&dateType=Gregorian&idType=1&monthsCount=3",
"host": [
"{{baseUrl}}"
],
"path": [
"sandbox",
"average",
"v1",
"employees",
":personalIdNum",
"payslips"
],
"query": [
{
"key": "birthDate",
"value": "1989-08-12",
"description": "(Required) Employee Birth Date"
},
{
"key": "dateType",
"value": "Gregorian",
"description": "(Required) Date Type of Birth date"
},
{
"key": "idType",
"value": "1",
"description": "(Required) Type of Employee National Number"
},
{
"key": "monthsCount",
"value": "3",
"description": "(Required) Required Month. How many previous salary certificate you want to include in the average formula/calculation?"
}
],
"variable": [
{
"key": "personalIdNum",
"value": "1000000000",
"description": "(Required) Employee National Number"
}
]
}
},
"response": [
{
"name": "Ok",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "X_MOF_RqUID",
"value": "{{$guid}}",
"description": "(Required) Unique reference, GUID format"
},
{
"key": "X_MOF_ClientID",
"value": "{{clientID}}",
"description": "(Required) Client Id of Banks or fintech companies"
},
{
"key": "X_EXT_RequestReason",
"value": "card",
"description": "(Required) Consumer must to say the reason of this inquiry"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "",
"description": "Added as a part of security scheme: oauth2"
}
],
"url": {
"raw": "{{baseUrl}}/sandbox/average/v1/employees/:personalIdNum/payslips?birthDate=1989-08-12&dateType=Gregorian&idType=1&monthsCount=3",
"host": [
"{{baseUrl}}"
],
"path": [
"sandbox",
"average",
"v1",
"employees",
":personalIdNum",
"payslips"
],
"query": [
{
"key": "birthDate",
"value": "1989-08-12",
"description": "(Required) Employee Birth Date"
},
{
"key": "dateType",
"value": "Gregorian",
"description": "(Required) Date Type of Birth date"
},
{
"key": "idType",
"value": "1",
"description": "(Required) Type of Employee National Number"
},
{
"key": "monthsCount",
"value": "3",
"description": "(Required) Required Month. How many previous salary certificate you want to include in the average formula/calculation?"
}
],
"variable": [
{
"key": "personalIdNum"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"data\": [\n {\n \"personalInfo\": {\n \"employeeNameAr\": \"أحمد محمد أحمد\",\n \"employeeNameEn\": \"Ahmed Mohamed Ahmed\"\n },\n \"averageSalary\": [\n {\n \"agencyCode\": \"019001000000\",\n \"agencyName\": \"وزارة الشئون البلدية والقروية – الديوان العام\",\n \"iban\": \"SA9494030800899994888403\",\n \"bankCode\": \"RJHI\",\n \"bankName\": \"مصرف الراجحى\",\n \"agencyEmploymentDt\": \"1440-01-01\",\n \"netSalaryAverage\": 5346.462019627243,\n \"numberOfMonths\": 2882.487161020788\n },\n {\n \"agencyCode\": \"019001000000\",\n \"agencyName\": \"وزارة الشئون البلدية والقروية – الديوان العام\",\n \"iban\": \"SA9494030800899994888403\",\n \"bankCode\": \"RJHI\",\n \"bankName\": \"مصرف الراجحى\",\n \"agencyEmploymentDt\": \"1440-01-01\",\n \"netSalaryAverage\": 6173.004514945741,\n \"numberOfMonths\": 9446.586846312419\n }\n ]\n },\n {\n \"personalInfo\": {\n \"employeeNameAr\": \"أحمد محمد أحمد\",\n \"employeeNameEn\": \"Ahmed Mohamed Ahmed\"\n },\n \"averageSalary\": [\n {\n \"agencyCode\": \"019001000000\",\n \"agencyName\": \"وزارة الشئون البلدية والقروية – الديوان العام\",\n \"iban\": \"SA9494030800899994888403\",\n \"bankCode\": \"RJHI\",\n \"bankName\": \"مصرف الراجحى\",\n \"agencyEmploymentDt\": \"1440-01-01\",\n \"netSalaryAverage\": 5499.120576485463,\n \"numberOfMonths\": 1662.0656075287466\n },\n {\n \"agencyCode\": \"019001000000\",\n \"agencyName\": \"وزارة الشئون البلدية والقروية – الديوان العام\",\n \"iban\": \"SA9494030800899994888403\",\n \"bankCode\": \"RJHI\",\n \"bankName\": \"مصرف الراجحى\",\n \"agencyEmploymentDt\": \"1440-01-01\",\n \"netSalaryAverage\": 6935.233705861679,\n \"numberOfMonths\": 611.7583729572896\n }\n ]\n }\n ]\n}"
},
{
"name": "A",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "X_MOF_RqUID",
"value": "{{$guid}}",
"description": "(Required) Unique reference, GUID format"
},
{
"key": "X_MOF_ClientID",
"value": "{{clientID}}",
"description": "(Required) Client Id of Banks or fintech companies"
},
{
"key": "X_EXT_RequestReason",
"value": "card",
"description": "(Required) Consumer must to say the reason of this inquiry"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "",
"description": "Added as a part of security scheme: oauth2"
}
],
"url": {
"raw": "{{baseUrl}}/sandbox/average/v1/employees/:personalIdNum/payslips?birthDate=1989-08-12&dateType=Gregorian&idType=1&monthsCount=3",
"host": [
"{{baseUrl}}"
],
"path": [
"sandbox",
"average",
"v1",
"employees",
":personalIdNum",
"payslips"
],
"query": [
{
"key": "birthDate",
"value": "1989-08-12",
"description": "(Required) Employee Birth Date"
},
{
"key": "dateType",
"value": "Gregorian",
"description": "(Required) Date Type of Birth date"
},
{
"key": "idType",
"value": "1",
"description": "(Required) Type of Employee National Number"
},
{
"key": "monthsCount",
"value": "3",
"description": "(Required) Required Month. How many previous salary certificate you want to include in the average formula/calculation?"
}
],
"variable": [
{
"key": "personalIdNum"
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"code\": \"A001400\",\n \"details\": \"Some Required Fields are not founded in your request, Please return to documentation,\",\n \"type\": \"BusinessError,\",\n \"link\": null,\n \"in\": [\n {\n \"name\": \"nationalNumber\",\n \"type\": \"query\"\n }\n ]\n}"
},
{
"name": "B",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "X_MOF_RqUID",
"value": "{{$guid}}",
"description": "(Required) Unique reference, GUID format"
},
{
"key": "X_MOF_ClientID",
"value": "{{clientID}}",
"description": "(Required) Client Id of Banks or fintech companies"
},
{
"key": "X_EXT_RequestReason",
"value": "card",
"description": "(Required) Consumer must to say the reason of this inquiry"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "",
"description": "Added as a part of security scheme: oauth2"
}
],
"url": {
"raw": "{{baseUrl}}/sandbox/average/v1/employees/:personalIdNum/payslips?birthDate=1989-08-12&dateType=Gregorian&idType=1&monthsCount=3",
"host": [
"{{baseUrl}}"
],
"path": [
"sandbox",
"average",
"v1",
"employees",
":personalIdNum",
"payslips"
],
"query": [
{
"key": "birthDate",
"value": "1989-08-12",
"description": "(Required) Employee Birth Date"
},
{
"key": "dateType",
"value": "Gregorian",
"description": "(Required) Date Type of Birth date"
},
{
"key": "idType",
"value": "1",
"description": "(Required) Type of Employee National Number"
},
{
"key": "monthsCount",
"value": "3",
"description": "(Required) Required Month. How many previous salary certificate you want to include in the average formula/calculation?"
}
],
"variable": [
{
"key": "personalIdNum"
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"code\": \"A002400\",\n \"details\": \"Validation format failed. Please return to documentations.\",\n \"type\": \"BusinessError\",\n \"link\": \"\",\n \"in\": [\n {\n \"name\": \"nationalNumber\",\n \"type\": \"query\",\n \"reason\": \"Invalid white space character\"\n },\n {\n \"name\": \"birthDate\",\n \"type\": \"query\",\n \"reason\": \"Invalid white space character\"\n }\n ]\n}"
},
{
"name": "Unauthorized",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "X_MOF_RqUID",
"value": "{{$guid}}",
"description": "(Required) Unique reference, GUID format"
},
{
"key": "X_MOF_ClientID",
"value": "{{clientID}}",
"description": "(Required) Client Id of Banks or fintech companies"
},
{
"key": "X_EXT_RequestReason",
"value": "card",
"description": "(Required) Consumer must to say the reason of this inquiry"
},
{
"key": "Authorization",
"value": "",
"description": "Added as a part of security scheme: oauth2"
}
],
"url": {
"raw": "{{baseUrl}}/sandbox/average/v1/employees/:personalIdNum/payslips?birthDate=1989-08-12&dateType=Gregorian&idType=1&monthsCount=3",
"host": [
"{{baseUrl}}"
],
"path": [
"sandbox",
"average",
"v1",
"employees",
":personalIdNum",
"payslips"
],
"query": [
{
"key": "birthDate",
"value": "1989-08-12",
"description": "(Required) Employee Birth Date"
},
{
"key": "dateType",
"value": "Gregorian",
"description": "(Required) Date Type of Birth date"
},
{
"key": "idType",
"value": "1",
"description": "(Required) Type of Employee National Number"
},
{
"key": "monthsCount",
"value": "3",
"description": "(Required) Required Month. How many previous salary certificate you want to include in the average formula/calculation?"
}
],
"variable": [
{
"key": "personalIdNum"
}
]
}
},
"status": "Unauthorized",
"code": 401,
"_postman_previewlanguage": "text",
"header": [],
"cookie": [],
"body": ""
},
{
"name": "Forbidden",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "X_MOF_RqUID",
"value": "{{$guid}}",
"description": "(Required) Unique reference, GUID format"
},
{
"key": "X_MOF_ClientID",
"value": "{{clientID}}",
"description": "(Required) Client Id of Banks or fintech companies"
},
{
"key": "X_EXT_RequestReason",
"value": "card",
"description": "(Required) Consumer must to say the reason of this inquiry"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "",
"description": "Added as a part of security scheme: oauth2"
}
],
"url": {
"raw": "{{baseUrl}}/sandbox/average/v1/employees/:personalIdNum/payslips?birthDate=1989-08-12&dateType=Gregorian&idType=1&monthsCount=3",
"host": [
"{{baseUrl}}"
],
"path": [
"sandbox",
"average",
"v1",
"employees",
":personalIdNum",
"payslips"
],
"query": [
{
"key": "birthDate",
"value": "1989-08-12",
"description": "(Required) Employee Birth Date"
},
{
"key": "dateType",
"value": "Gregorian",
"description": "(Required) Date Type of Birth date"
},
{
"key": "idType",
"value": "1",
"description": "(Required) Type of Employee National Number"
},
{
"key": "monthsCount",
"value": "3",
"description": "(Required) Required Month. How many previous salary certificate you want to include in the average formula/calculation?"
}
],
"variable": [
{
"key": "personalIdNum"
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n {\n \"code\": \"A001403\",\n \"details\": \"Error Message Detail\",\n \"type\": \"BusinessError\",\n \"link\": \"eYefOXKlfKbYrYwpiQPIHzsH.jnsz\"\n },\n {\n \"code\": \"A001403\",\n \"details\": \"Error Message Detail\",\n \"type\": \"BusinessError\",\n \"link\": \"dkEIxEFjheXaaqx.nq\"\n }\n ]\n}"
},
{
"name": "C",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "X_MOF_RqUID",
"value": "{{$guid}}",
"description": "(Required) Unique reference, GUID format"
},
{
"key": "X_MOF_ClientID",
"value": "{{clientID}}",
"description": "(Required) Client Id of Banks or fintech companies"
},
{
"key": "X_EXT_RequestReason",
"value": "card",
"description": "(Required) Consumer must to say the reason of this inquiry"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "",
"description": "Added as a part of security scheme: oauth2"
}
],
"url": {
"raw": "{{baseUrl}}/sandbox/average/v1/employees/:personalIdNum/payslips?birthDate=1989-08-12&dateType=Gregorian&idType=1&monthsCount=3",
"host": [
"{{baseUrl}}"
],
"path": [
"sandbox",
"average",
"v1",
"employees",
":personalIdNum",
"payslips"
],
"query": [
{
"key": "birthDate",
"value": "1989-08-12",
"description": "(Required) Employee Birth Date"
},
{
"key": "dateType",
"value": "Gregorian",
"description": "(Required) Date Type of Birth date"
},
{
"key": "idType",
"value": "1",
"description": "(Required) Type of Employee National Number"
},
{
"key": "monthsCount",
"value": "3",
"description": "(Required) Required Month. How many previous salary certificate you want to include in the average formula/calculation?"
}
],
"variable": [
{
"key": "personalIdNum"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"code\": \"A001404,\",\n \"details\": \"NO Data Found,\",\n \"type\": \"BusinessError,\",\n \"link\": null\n}"
},
{
"name": "D",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "X_MOF_RqUID",
"value": "{{$guid}}",
"description": "(Required) Unique reference, GUID format"
},
{
"key": "X_MOF_ClientID",
"value": "{{clientID}}",
"description": "(Required) Client Id of Banks or fintech companies"
},
{
"key": "X_EXT_RequestReason",
"value": "card",
"description": "(Required) Consumer must to say the reason of this inquiry"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "",
"description": "Added as a part of security scheme: oauth2"
}
],
"url": {
"raw": "{{baseUrl}}/sandbox/average/v1/employees/:personalIdNum/payslips?birthDate=1989-08-12&dateType=Gregorian&idType=1&monthsCount=3",
"host": [
"{{baseUrl}}"
],
"path": [
"sandbox",
"average",
"v1",
"employees",
":personalIdNum",
"payslips"
],
"query": [
{
"key": "birthDate",
"value": "1989-08-12",
"description": "(Required) Employee Birth Date"
},
{
"key": "dateType",
"value": "Gregorian",
"description": "(Required) Date Type of Birth date"
},
{
"key": "idType",
"value": "1",
"description": "(Required) Type of Employee National Number"
},
{
"key": "monthsCount",
"value": "3",
"description": "(Required) Required Month. How many previous salary certificate you want to include in the average formula/calculation?"
}
],
"variable": [
{
"key": "personalIdNum"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"code\": \"A101404\",\n \"details\": \"The employee info are not matched with any of our records, please inform the employee to check his info with his entity's HR\",\n \"type\": \"BusinessError\",\n \"link\": \"\"\n}"
},
{
"name": "Backend Timeout",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "X_MOF_RqUID",
"value": "{{$guid}}",
"description": "(Required) Unique reference, GUID format"
},
{
"key": "X_MOF_ClientID",
"value": "{{clientID}}",
"description": "(Required) Client Id of Banks or fintech companies"
},
{
"key": "X_EXT_RequestReason",
"value": "card",
"description": "(Required) Consumer must to say the reason of this inquiry"
},
{
"key": "Authorization",
"value": "",
"description": "Added as a part of security scheme: oauth2"
}
],
"url": {
"raw": "{{baseUrl}}/sandbox/average/v1/employees/:personalIdNum/payslips?birthDate=1989-08-12&dateType=Gregorian&idType=1&monthsCount=3",
"host": [
"{{baseUrl}}"
],
"path": [
"sandbox",
"average",
"v1",
"employees",
":personalIdNum",
"payslips"
],
"query": [
{
"key": "birthDate",
"value": "1989-08-12",
"description": "(Required) Employee Birth Date"
},
{
"key": "dateType",
"value": "Gregorian",
"description": "(Required) Date Type of Birth date"
},
{
"key": "idType",
"value": "1",
"description": "(Required) Type of Employee National Number"
},
{
"key": "monthsCount",
"value": "3",
"description": "(Required) Required Month. How many previous salary certificate you want to include in the average formula/calculation?"
}
],
"variable": [
{
"key": "personalIdNum"
}
]
}
},
"status": "Request Timeout",
"code": 408,
"_postman_previewlanguage": "text",
"header": [],
"cookie": [],
"body": ""
},
{
"name": "Internal Server Error",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "X_MOF_RqUID",
"value": "{{$guid}}",
"description": "(Required) Unique reference, GUID format"
},
{
"key": "X_MOF_ClientID",
"value": "{{clientID}}",
"description": "(Required) Client Id of Banks or fintech companies"
},
{
"key": "X_EXT_RequestReason",
"value": "card",
"description": "(Required) Consumer must to say the reason of this inquiry"
},
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "",
"description": "Added as a part of security scheme: oauth2"
}
],
"url": {
"raw": "{{baseUrl}}/sandbox/average/v1/employees/:personalIdNum/payslips?birthDate=1989-08-12&dateType=Gregorian&idType=1&monthsCount=3",
"host": [
"{{baseUrl}}"
],
"path": [
"sandbox",
"average",
"v1",
"employees",
":personalIdNum",
"payslips"
],
"query": [
{
"key": "birthDate",
"value": "1989-08-12",
"description": "(Required) Employee Birth Date"
},
{
"key": "dateType",
"value": "Gregorian",
"description": "(Required) Date Type of Birth date"
},
{
"key": "idType",
"value": "1",
"description": "(Required) Type of Employee National Number"
},
{
"key": "monthsCount",
"value": "3",
"description": "(Required) Required Month. How many previous salary certificate you want to include in the average formula/calculation?"
}
],
"variable": [
{
"key": "personalIdNum"
}
]
}
},
"status": "Internal Server Error",
"code": 500,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\n \"errors\": [\n {\n \"code\": \"A001500\",\n \"details\": \"Internal Server Error\",\n \"type\": \"BusinessError\",\n \"link\": \"gsbGE.pg\"\n },\n {\n \"code\": \"A001500\",\n \"details\": \"Internal Server Error\",\n \"type\": \"BusinessError\",\n \"link\": \"jzRn.asa\"\n }\n ]\n}"
}
]
}
]
}
]
}
]
}
]
}
]
}
]
}
],
"auth": {
"type": "oauth2",
"oauth2": [
{
"key": "scope",
"value": "ReadAverageSalaryCertificate",
"type": "string"
},
{
"key": "accessTokenUrl",
"value": "{{baseUrl}}/sandbox/oauth/v2/accesstoken",
"type": "string"
},
{
"key": "X_MOF_ClientID",
"value": "{{clientID}}",
"type": "string"
},
{
"key": "grant_type",
"value": "client_credentials",
"type": "string"
}
]
},
"event": [
{
"listen": "prerequest",
"script": {
"type": "text/javascript",
"packages": {},
"requests": {},
"exec": [
""
]
}
},
{
"listen": "test",
"script": {
"type": "text/javascript",
"packages": {},
"requests": {},
"exec": [
""
]
}
}
],
"variable": [
{
"key": "baseUrl",
"value": "https://sandboxapi.etimad.sa"
},
{
"key": "clientID",
"value": "JRZgTE5h1zRxpiYMFpv85VgdvMoEGGcN"
},
{
"key": "clientSecret",
"value": "2nDfAXilPMrfW70v"
}
]
}