NAV Navigation
Shell HTTP JavaScript Ruby Python PHP Java Go

WebHR API v3.0.0

Scroll down for code samples, example requests and responses. Select a language for code samples from the tabs above or the mobile navigation menu.

WebHR offers RESTful Application Programming Interface (API), based on semantically meaningful HTTPS requests to access or modify a resource within WebHR. The APIs can be used to either enter data into WebHR or extract data out of WebHR depending upon the nature of API and the need by an external application.

Base URLs:

Email: WebHR Support License: MIT

Authentication

Scope Scope Description
Full_Access Full access to all resources

Organization

CompaniesList

Code samples

# You can also use wget
curl -X GET https://api1.webhr.co/v3/?module=Organization&submodule=Companies?request= \
  -H 'Accept: application/json'
GET https://api1.webhr.co/v3/?module=Organization&submodule=Companies?request= HTTP/1.1
Host: api1.webhr.co
Accept: application/json

const headers = {
  'Accept':'application/json'
};

fetch('https://api1.webhr.co/v3/?module=Organization&submodule=Companies?request=',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'https://api1.webhr.co/v3/?module=Organization&submodule=Companies',
  params: {
  'request' => 'string(varchar255)'
}, headers: headers

p JSON.parse(result)
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('https://api1.webhr.co/v3/?module=Organization&submodule=Companies', params={
  'request': ''
}, headers = headers)

print(r.json())
<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api1.webhr.co/v3/?module=Organization&submodule=Companies', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...
URL obj = new URL("https://api1.webhr.co/v3/?module=Organization&submodule=Companies?request=");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api1.webhr.co/v3/?module=Organization&submodule=Companies", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET ?module=Organization&submodule=Companies

Lists all Companies in your WebHR account

Parameters

Name In Type Required Description
request query string(varchar255) true “List” is required in request parameter to fetch data from WebHR

Example responses

200 Response

{
  "Status": 1,
  "Summary": {
    "Page": 1,
    "RecordsPerPage": 10,
    "TotalRecords": 0,
    "Offset": 0,
    "NumberOfPages": 0,
    "Search": "string",
    "NextPageURL": "string"
  },
  "Data": [
    {
      "FieldId": "string",
      "DataFields": {
        "Company": "string",
        "LegalName": "string",
        "ContactNumber": "string",
        "FaxNumber": "string",
        "EmailAddress": "string",
        "Website": "string",
        "BankName": "string",
        "AccountTitle": "string",
        "AccountNumber": "string",
        "RoutingNumber": "string",
        "AccountType": "string"
      }
    }
  ]
}

Responses

Status Meaning Description Schema
200 OK OK Companies

DivisionsList

Code samples

# You can also use wget
curl -X GET https://api1.webhr.co/v3/?module=Organization&submodule=Divisions?request= \
  -H 'Accept: application/json'
GET https://api1.webhr.co/v3/?module=Organization&submodule=Divisions?request= HTTP/1.1
Host: api1.webhr.co
Accept: application/json

const headers = {
  'Accept':'application/json'
};

fetch('https://api1.webhr.co/v3/?module=Organization&submodule=Divisions?request=',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'https://api1.webhr.co/v3/?module=Organization&submodule=Divisions',
  params: {
  'request' => 'string(varchar255)'
}, headers: headers

p JSON.parse(result)
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('https://api1.webhr.co/v3/?module=Organization&submodule=Divisions', params={
  'request': ''
}, headers = headers)

print(r.json())
<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api1.webhr.co/v3/?module=Organization&submodule=Divisions', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...
URL obj = new URL("https://api1.webhr.co/v3/?module=Organization&submodule=Divisions?request=");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api1.webhr.co/v3/?module=Organization&submodule=Divisions", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET ?module=Organization&submodule=Divisions

Lists all Divisions in your WebHR account

Parameters

Name In Type Required Description
request query string(varchar255) true “List” is required in request parameter to fetch data from WebHR

Example responses

200 Response

{
  "Status": 1,
  "Summary": {
    "Page": 1,
    "RecordsPerPage": 10,
    "TotalRecords": 0,
    "Offset": 0,
    "NumberOfPages": 0,
    "Search": "string",
    "NextPageURL": "string"
  },
  "Data": [
    {
      "FieldId": "string",
      "DataFields": {
        "Company": "string",
        "DivisionType": "string",
        "DivisionName": "string",
        "DivisionHead": "string"
      }
    }
  ]
}

Responses

Status Meaning Description Schema
200 OK OK Divisions

StationsList

Code samples

# You can also use wget
curl -X GET https://api1.webhr.co/v3/?module=Organization&submodule=Stations?request= \
  -H 'Accept: application/json'
GET https://api1.webhr.co/v3/?module=Organization&submodule=Stations?request= HTTP/1.1
Host: api1.webhr.co
Accept: application/json

const headers = {
  'Accept':'application/json'
};

fetch('https://api1.webhr.co/v3/?module=Organization&submodule=Stations?request=',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'https://api1.webhr.co/v3/?module=Organization&submodule=Stations',
  params: {
  'request' => 'string(varchar255)'
}, headers: headers

p JSON.parse(result)
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('https://api1.webhr.co/v3/?module=Organization&submodule=Stations', params={
  'request': ''
}, headers = headers)

print(r.json())
<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api1.webhr.co/v3/?module=Organization&submodule=Stations', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...
URL obj = new URL("https://api1.webhr.co/v3/?module=Organization&submodule=Stations?request=");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api1.webhr.co/v3/?module=Organization&submodule=Stations", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET ?module=Organization&submodule=Stations

Lists all Stations in your WebHR account

Parameters

Name In Type Required Description
request query string(varchar255) true “List” is required in request parameter to fetch data from WebHR

Example responses

200 Response

{
  "Status": 1,
  "Summary": {
    "Page": 1,
    "RecordsPerPage": 10,
    "TotalRecords": 0,
    "Offset": 0,
    "NumberOfPages": 0,
    "Search": "string",
    "NextPageURL": "string"
  },
  "Data": [
    {
      "FieldId": "string",
      "DataFields": {
        "StationName": "string",
        "Address": "string",
        "City": "string",
        "State": "string",
        "ZipCode": "string",
        "Country": "string",
        "PhoneNumber": "string",
        "FaxNumber": "string",
        "EmailAddress": "string",
        "Website": "string",
        "Latitude": "string",
        "Longitude": "string",
        "StationHead": "string",
        "StationGeneralManager": "string",
        "StationCurrency": "string"
      }
    }
  ]
}

Responses

Status Meaning Description Schema
200 OK OK Stations

DepartmentsList

Code samples

# You can also use wget
curl -X GET https://api1.webhr.co/v3/?module=Organization&submodule=Departments?request= \
  -H 'Accept: application/json'
GET https://api1.webhr.co/v3/?module=Organization&submodule=Departments?request= HTTP/1.1
Host: api1.webhr.co
Accept: application/json

const headers = {
  'Accept':'application/json'
};

fetch('https://api1.webhr.co/v3/?module=Organization&submodule=Departments?request=',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'https://api1.webhr.co/v3/?module=Organization&submodule=Departments',
  params: {
  'request' => 'string(varchar255)'
}, headers: headers

p JSON.parse(result)
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('https://api1.webhr.co/v3/?module=Organization&submodule=Departments', params={
  'request': ''
}, headers = headers)

print(r.json())
<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api1.webhr.co/v3/?module=Organization&submodule=Departments', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...
URL obj = new URL("https://api1.webhr.co/v3/?module=Organization&submodule=Departments?request=");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api1.webhr.co/v3/?module=Organization&submodule=Departments", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET ?module=Organization&submodule=Departments

Lists all Departments in your WebHR account

Parameters

Name In Type Required Description
request query string(varchar255) true “List” is required in request parameter to fetch data from WebHR

Example responses

200 Response

{
  "Status": 1,
  "Summary": {
    "Page": 1,
    "RecordsPerPage": 10,
    "TotalRecords": 0,
    "Offset": 0,
    "NumberOfPages": 0,
    "Search": "string",
    "NextPageURL": "string"
  },
  "Data": [
    {
      "FieldId": "string",
      "DataFields": {
        "Company": null,
        "Division": "string",
        "Station": "string",
        "DepartmentName": "string",
        "DepartmentHead": "string",
        "ParentDepartment": "string"
      }
    }
  ]
}

Responses

Status Meaning Description Schema
200 OK OK Departments

CustomFieldsList

Code samples

# You can also use wget
curl -X GET https://api1.webhr.co/v3/?module=Organization&submodule=CustomFields?request= \
  -H 'Accept: application/json'
GET https://api1.webhr.co/v3/?module=Organization&submodule=CustomFields?request= HTTP/1.1
Host: api1.webhr.co
Accept: application/json

const headers = {
  'Accept':'application/json'
};

fetch('https://api1.webhr.co/v3/?module=Organization&submodule=CustomFields?request=',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'https://api1.webhr.co/v3/?module=Organization&submodule=CustomFields',
  params: {
  'request' => 'string(varchar255)'
}, headers: headers

p JSON.parse(result)
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('https://api1.webhr.co/v3/?module=Organization&submodule=CustomFields', params={
  'request': ''
}, headers = headers)

print(r.json())
<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api1.webhr.co/v3/?module=Organization&submodule=CustomFields', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...
URL obj = new URL("https://api1.webhr.co/v3/?module=Organization&submodule=CustomFields?request=");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api1.webhr.co/v3/?module=Organization&submodule=CustomFields", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET ?module=Organization&submodule=CustomFields

Lists all Custom Fields in your WebHR account

Parameters

Name In Type Required Description
request query string(varchar255) true “List” is required in request parameter to fetch data from WebHR

Example responses

200 Response

{
  "RecordId": "string",
  "ComponentName": "string",
  "CustomFieldName": "string",
  "CustomFieldCategory": "string",
  "MandatoryField": "string",
  "CustomFieldType": "string",
  "CustomFieldOrder": "string",
  "CustomFieldPosition": "string",
  "CustomFieldTypeValues": null,
  "Instructions": "string"
}

Responses

Status Meaning Description Schema
200 OK OK CustomFieldsList

UpdateCustomField

Code samples

# You can also use wget
curl -X GET https://api1.webhr.co/v3/?module=Organization&submodule=UpdateCustomField?request=&params=RecordId,string,CustomFieldName,string,CustomFieldCategory,string,MandatoryField,string,CustomFieldType,string,CustomFieldOrder,string,CustomFieldPosition,string \
  -H 'Accept: application/json'
GET https://api1.webhr.co/v3/?module=Organization&submodule=UpdateCustomField?request=&params=RecordId,string,CustomFieldName,string,CustomFieldCategory,string,MandatoryField,string,CustomFieldType,string,CustomFieldOrder,string,CustomFieldPosition,string HTTP/1.1
Host: api1.webhr.co
Accept: application/json

const headers = {
  'Accept':'application/json'
};

fetch('https://api1.webhr.co/v3/?module=Organization&submodule=UpdateCustomField?request=&params=RecordId,string,CustomFieldName,string,CustomFieldCategory,string,MandatoryField,string,CustomFieldType,string,CustomFieldOrder,string,CustomFieldPosition,string',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'https://api1.webhr.co/v3/?module=Organization&submodule=UpdateCustomField',
  params: {
  'request' => 'string(varchar255)',
'params' => '[UpdateCustomField](#schemaupdatecustomfield)'
}, headers: headers

p JSON.parse(result)
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('https://api1.webhr.co/v3/?module=Organization&submodule=UpdateCustomField', params={
  'request': '',  'params': {
  "RecordId": "string",
  "CustomFieldName": "string",
  "CustomFieldCategory": "string",
  "MandatoryField": "string",
  "CustomFieldType": "string",
  "CustomFieldOrder": "string",
  "CustomFieldPosition": "string",
  "CustomFieldTypeValues": null
}
}, headers = headers)

print(r.json())
<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api1.webhr.co/v3/?module=Organization&submodule=UpdateCustomField', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...
URL obj = new URL("https://api1.webhr.co/v3/?module=Organization&submodule=UpdateCustomField?request=&params=RecordId,string,CustomFieldName,string,CustomFieldCategory,string,MandatoryField,string,CustomFieldType,string,CustomFieldOrder,string,CustomFieldPosition,string");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api1.webhr.co/v3/?module=Organization&submodule=UpdateCustomField", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET ?module=Organization&submodule=UpdateCustomField

Update Custom Field in your WebHR account

Parameters

Name In Type Required Description
request query string(varchar255) true “Update” is required in request to update custom field.
params query UpdateCustomField true JSON Array

Detailed descriptions

request: “Update” is required in request to update custom field. Example:params={“RecordId”:“WyIxMyIsMTYxNTk5MTIyN10=”, “CustomFieldTypeValues”:[“1”, “2”, “3”]}

params: JSON Array “JSON Array” of params

Example responses

Success Response

"string"

Responses

Status Meaning Description Schema
Success Unknown Success -> Record Updated Successfully. string
Error Unknown Error -> Something went wrong, Please contact your administrator… string

CustomFieldDependenciesList

Code samples

# You can also use wget
curl -X GET https://api1.webhr.co/v3/?module=Organization&submodule=CustomFieldDependencies&request=List?request= \
  -H 'Accept: application/json'
GET https://api1.webhr.co/v3/?module=Organization&submodule=CustomFieldDependencies&request=List?request= HTTP/1.1
Host: api1.webhr.co
Accept: application/json

const headers = {
  'Accept':'application/json'
};

fetch('https://api1.webhr.co/v3/?module=Organization&submodule=CustomFieldDependencies&request=List?request=',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'https://api1.webhr.co/v3/?module=Organization&submodule=CustomFieldDependencies&request=List',
  params: {
  'request' => 'string(varchar255)'
}, headers: headers

p JSON.parse(result)
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('https://api1.webhr.co/v3/?module=Organization&submodule=CustomFieldDependencies&request=List', params={
  'request': ''
}, headers = headers)

print(r.json())
<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api1.webhr.co/v3/?module=Organization&submodule=CustomFieldDependencies&request=List', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...
URL obj = new URL("https://api1.webhr.co/v3/?module=Organization&submodule=CustomFieldDependencies&request=List?request=");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api1.webhr.co/v3/?module=Organization&submodule=CustomFieldDependencies&request=List", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET ?module=Organization&submodule=CustomFieldDependencies&request=List

Lists Custom Field Dependencies in your WebHR account

Parameters

Name In Type Required Description
request query string(varchar255) true “List” is required in request parameter to fetch data from WebHR

Example responses

200 Response

{
  "RecordId": "string",
  "Source": "string",
  "Destination": "string",
  "SourceOption": "string",
  "DestinationOptions": null,
  "SourceId": 0,
  "DestinationId": 0
}

Responses

Status Meaning Description Schema
200 OK OK CustomFieldDependencies

AddCustomFieldDependencies

Code samples

# You can also use wget
curl -X POST https://api1.webhr.co/v3/?module=Organization&submodule=CustomFieldDependencies&request=Add?request= \
  -H 'Accept: application/json'
POST https://api1.webhr.co/v3/?module=Organization&submodule=CustomFieldDependencies&request=Add?request= HTTP/1.1
Host: api1.webhr.co
Accept: application/json

const headers = {
  'Accept':'application/json'
};

fetch('https://api1.webhr.co/v3/?module=Organization&submodule=CustomFieldDependencies&request=Add?request=',
{
  method: 'POST',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.post 'https://api1.webhr.co/v3/?module=Organization&submodule=CustomFieldDependencies&request=Add',
  params: {
  'request' => 'string(varchar255)',
'params' => 'undefined'
}, headers: headers

p JSON.parse(result)
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.post('https://api1.webhr.co/v3/?module=Organization&submodule=CustomFieldDependencies&request=Add', params={
  'request': '',  'params': undefined
}, headers = headers)

print(r.json())
<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','https://api1.webhr.co/v3/?module=Organization&submodule=CustomFieldDependencies&request=Add', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...
URL obj = new URL("https://api1.webhr.co/v3/?module=Organization&submodule=CustomFieldDependencies&request=Add?request=");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://api1.webhr.co/v3/?module=Organization&submodule=CustomFieldDependencies&request=Add", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST ?module=Organization&submodule=CustomFieldDependencies&request=Add

Add Custom Field Dependencies in your WebHR account

Parameters

Name In Type Required Description
request query string(varchar255) true “Add” is required in request to add Data
params query undefined true “JSON Array” of Custom Field Dependencies

Detailed descriptions

request: “Add” is required in request to add Data “Add” is required in request parameter to add Data

params: “JSON Array” of Custom Field Dependencies Example:params={“Module”:“Travels”,“SourceId”:“150”,“DestinationId”:“151”,“SourceOption”:“2”,“DestinationOptions”:[“1”, “2”, “3”]}

Example responses

Success Response

"string"

Responses

Status Meaning Description Schema
Success Unknown Message -> Record addedd Successfully… string
Fail Unknown Message -> Something went wrong, Please contact your administrator… string

UpdateCustomFieldDependencies

Code samples

# You can also use wget
curl -X POST https://api1.webhr.co/v3/?module=Organization&submodule=CustomFieldDependencies&request=Update?request= \
  -H 'Accept: application/json'
POST https://api1.webhr.co/v3/?module=Organization&submodule=CustomFieldDependencies&request=Update?request= HTTP/1.1
Host: api1.webhr.co
Accept: application/json

const headers = {
  'Accept':'application/json'
};

fetch('https://api1.webhr.co/v3/?module=Organization&submodule=CustomFieldDependencies&request=Update?request=',
{
  method: 'POST',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.post 'https://api1.webhr.co/v3/?module=Organization&submodule=CustomFieldDependencies&request=Update',
  params: {
  'request' => 'string(varchar255)',
'params' => 'undefined'
}, headers: headers

p JSON.parse(result)
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.post('https://api1.webhr.co/v3/?module=Organization&submodule=CustomFieldDependencies&request=Update', params={
  'request': '',  'params': undefined
}, headers = headers)

print(r.json())
<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','https://api1.webhr.co/v3/?module=Organization&submodule=CustomFieldDependencies&request=Update', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...
URL obj = new URL("https://api1.webhr.co/v3/?module=Organization&submodule=CustomFieldDependencies&request=Update?request=");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://api1.webhr.co/v3/?module=Organization&submodule=CustomFieldDependencies&request=Update", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST ?module=Organization&submodule=CustomFieldDependencies&request=Update

Update Custom Field Dependencies in your WebHR account

Parameters

Name In Type Required Description
request query string(varchar255) true “Update” is required in request to update data
params query undefined true “JSON Array” of Custom Field Dependencies

Detailed descriptions

request: “Update” is required in request to update data “Update” is required in request parameter to update data

params: “JSON Array” of Custom Field Dependencies Example:params={“RecordId”:“q6vXOAcUyn”,“Module”:“Travels”,“SourceId”:“150”,“DestinationId”:“151”,“SourceOption”:“2”,“DestinationOptions”:[“1”, “2”, “3”]}

Example responses

Success Response

"string"

Responses

Status Meaning Description Schema
Success Unknown Message -> Record Updated Successfully… string
Fail Unknown Message -> Something went wrong, Please contact your administrator… string

DeleteCustomFieldDependencies

Code samples

# You can also use wget
curl -X POST https://api1.webhr.co/v3/?module=Organization&submodule=CustomFieldDependencies&request=Delete?request= \
  -H 'Accept: application/json'
POST https://api1.webhr.co/v3/?module=Organization&submodule=CustomFieldDependencies&request=Delete?request= HTTP/1.1
Host: api1.webhr.co
Accept: application/json

const headers = {
  'Accept':'application/json'
};

fetch('https://api1.webhr.co/v3/?module=Organization&submodule=CustomFieldDependencies&request=Delete?request=',
{
  method: 'POST',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.post 'https://api1.webhr.co/v3/?module=Organization&submodule=CustomFieldDependencies&request=Delete',
  params: {
  'request' => 'string(varchar255)',
'params' => 'undefined'
}, headers: headers

p JSON.parse(result)
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.post('https://api1.webhr.co/v3/?module=Organization&submodule=CustomFieldDependencies&request=Delete', params={
  'request': '',  'params': undefined
}, headers = headers)

print(r.json())
<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','https://api1.webhr.co/v3/?module=Organization&submodule=CustomFieldDependencies&request=Delete', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...
URL obj = new URL("https://api1.webhr.co/v3/?module=Organization&submodule=CustomFieldDependencies&request=Delete?request=");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://api1.webhr.co/v3/?module=Organization&submodule=CustomFieldDependencies&request=Delete", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST ?module=Organization&submodule=CustomFieldDependencies&request=Delete

Delete Custom Field Dependencies in your WebHR account

Parameters

Name In Type Required Description
request query string(varchar255) true “Delete” is required in request to delete data
params query undefined true “JSON Array” of Custom Field Dependencies

Detailed descriptions

request: “Delete” is required in request to delete data “Delete” is required in request parameter to delete data

params: “JSON Array” of Custom Field Dependencies Example:params={“RecordId”:“q6vXOAcUyn”, “Module”:“Travels”}

Example responses

Success Response

"string"

Responses

Status Meaning Description Schema
Success Unknown Message -> Record Deleted Successfully… string
Fail Unknown Message -> Something went wrong, Please contact your administrator… string

Employees

EmployeesList

Code samples

# You can also use wget
curl -X GET https://api1.webhr.co/v3/?module=Employees&submodule=Employees?request= \
  -H 'Accept: application/json'
GET https://api1.webhr.co/v3/?module=Employees&submodule=Employees?request= HTTP/1.1
Host: api1.webhr.co
Accept: application/json

const headers = {
  'Accept':'application/json'
};

fetch('https://api1.webhr.co/v3/?module=Employees&submodule=Employees?request=',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'https://api1.webhr.co/v3/?module=Employees&submodule=Employees',
  params: {
  'request' => 'string(varchar255)'
}, headers: headers

p JSON.parse(result)
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('https://api1.webhr.co/v3/?module=Employees&submodule=Employees', params={
  'request': ''
}, headers = headers)

print(r.json())
<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api1.webhr.co/v3/?module=Employees&submodule=Employees', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...
URL obj = new URL("https://api1.webhr.co/v3/?module=Employees&submodule=Employees?request=");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api1.webhr.co/v3/?module=Employees&submodule=Employees", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET ?module=Employees&submodule=Employees

Lists all Employees in your WebHR account

Parameters

Name In Type Required Description
request query string(varchar255) true “List” is required in request parameter to fetch data from WebHR
params query EmployeesParams false JSON Array of parameters to get filtered data

Example responses

200 Response

{
  "Status": 1,
  "Summary": {
    "Page": 1,
    "RecordsPerPage": 10,
    "TotalRecords": 0,
    "Offset": 0,
    "NumberOfPages": 0,
    "Search": "string",
    "NextPageURL": "string"
  },
  "Data": [
    {
      "FieldId": "string",
      "DataFields": {
        "UserName": "string",
        "AccessCode": "string",
        "FirstName": "string",
        "LastName": "string",
        "MiddleName": "string",
        "FullName": "string",
        "EmailAddress": "string",
        "Status": "string",
        "Designation": "string",
        "CompanyName": "string",
        "DivisionName": "string",
        "DepartmentName": "string",
        "StationName": "string",
        "EmployeeCategory": "string",
        "EmployeeType": "string",
        "JoiningDate": "string",
        "GovernmentId": "string",
        "DateOfBirth": "string",
        "Gender": "string",
        "MaritalStatus": "string",
        "BloodGroup": "string",
        "PresentContactNumber": "string",
        "MobileNumber": "string",
        "OfficePhoneNumber": "string",
        "PositionCode": "string",
        "ReportsTo": "string",
        "PermanentAddress": "string",
        "PermanentCity": "string",
        "PermanentState": "string",
        "PermanentCountry": "string",
        "PresentAddress": "string",
        "PresentCity": "string",
        "PresentState": "string",
        "PresentCountry": "string"
      }
    }
  ]
}

Responses

Status Meaning Description Schema
200 OK OK Employees

AddEmployee

Code samples

# You can also use wget
curl -X POST https://api1.webhr.co/v3/?module=Employees&submodule=Employees?request=&data=CompanyName,string,DivisionName,string,StationName,string,DepartmentName,string,Designation,string,Grade,string,WorkShift,string,EmployeeCategory,string,EmployeeType,string,UserName,string,FirstName,string,LastName,string,Password,string,AllowLogin,string,EmailAddress,string,ShowInOrganogram,string,AccessCode,string,ReportsTo,string,Supervisor,string,Salutation,string,Nickname,string,DateofBirth,string,Gender,string,BloodGroup,string,Nationality,string,Religion,string,MaritalStatus,string,JoiningDate,string,GovernmentId,string,EmployeeTaxNumber,string,PresentAddress,string,PresentCity,string,PresentState,string,PresentZipCode,string,PresentCountry,string,PresentContactNumber,string,PermanentAddress,string,PermanentCity,string,PermanentState,string,PermanentZipCode,string,PermanentCountry,string,PermanentContactNumber,string,HomePhoneNumber,string,OfficePhoneNumber,string,MobileNumber,string,PassportNumber,string,PassportExpiration,string \
  -H 'Accept: application/json'
POST https://api1.webhr.co/v3/?module=Employees&submodule=Employees?request=&data=CompanyName,string,DivisionName,string,StationName,string,DepartmentName,string,Designation,string,Grade,string,WorkShift,string,EmployeeCategory,string,EmployeeType,string,UserName,string,FirstName,string,LastName,string,Password,string,AllowLogin,string,EmailAddress,string,ShowInOrganogram,string,AccessCode,string,ReportsTo,string,Supervisor,string,Salutation,string,Nickname,string,DateofBirth,string,Gender,string,BloodGroup,string,Nationality,string,Religion,string,MaritalStatus,string,JoiningDate,string,GovernmentId,string,EmployeeTaxNumber,string,PresentAddress,string,PresentCity,string,PresentState,string,PresentZipCode,string,PresentCountry,string,PresentContactNumber,string,PermanentAddress,string,PermanentCity,string,PermanentState,string,PermanentZipCode,string,PermanentCountry,string,PermanentContactNumber,string,HomePhoneNumber,string,OfficePhoneNumber,string,MobileNumber,string,PassportNumber,string,PassportExpiration,string HTTP/1.1
Host: api1.webhr.co
Accept: application/json

const headers = {
  'Accept':'application/json'
};

fetch('https://api1.webhr.co/v3/?module=Employees&submodule=Employees?request=&data=CompanyName,string,DivisionName,string,StationName,string,DepartmentName,string,Designation,string,Grade,string,WorkShift,string,EmployeeCategory,string,EmployeeType,string,UserName,string,FirstName,string,LastName,string,Password,string,AllowLogin,string,EmailAddress,string,ShowInOrganogram,string,AccessCode,string,ReportsTo,string,Supervisor,string,Salutation,string,Nickname,string,DateofBirth,string,Gender,string,BloodGroup,string,Nationality,string,Religion,string,MaritalStatus,string,JoiningDate,string,GovernmentId,string,EmployeeTaxNumber,string,PresentAddress,string,PresentCity,string,PresentState,string,PresentZipCode,string,PresentCountry,string,PresentContactNumber,string,PermanentAddress,string,PermanentCity,string,PermanentState,string,PermanentZipCode,string,PermanentCountry,string,PermanentContactNumber,string,HomePhoneNumber,string,OfficePhoneNumber,string,MobileNumber,string,PassportNumber,string,PassportExpiration,string',
{
  method: 'POST',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.post 'https://api1.webhr.co/v3/?module=Employees&submodule=Employees',
  params: {
  'request' => 'string(varchar255)',
'data' => '[AddEmployees](#schemaaddemployees)'
}, headers: headers

p JSON.parse(result)
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.post('https://api1.webhr.co/v3/?module=Employees&submodule=Employees', params={
  'request': '',  'data': {
  "CompanyName": "string",
  "DivisionName": "string",
  "StationName": "string",
  "DepartmentName": "string",
  "Designation": "string",
  "Grade": "string",
  "WorkShift": "string",
  "EmployeeCategory": "string",
  "EmployeeType": "string",
  "UserName": "string",
  "FirstName": "string",
  "LastName": "string",
  "Password": "string",
  "AllowLogin": "string",
  "EmailAddress": "string",
  "ShowInOrganogram": "string",
  "AccessCode": "string",
  "ReportsTo": "string",
  "Supervisor": "string",
  "Salutation": "string",
  "Nickname": "string",
  "DateofBirth": "string",
  "Gender": "string",
  "BloodGroup": "string",
  "Nationality": "string",
  "Religion": "string",
  "MaritalStatus": "string",
  "JoiningDate": "string",
  "GovernmentId": "string",
  "EmployeeTaxNumber": "string",
  "PresentAddress": "string",
  "PresentCity": "string",
  "PresentState": "string",
  "PresentZipCode": "string",
  "PresentCountry": "string",
  "PresentContactNumber": "string",
  "PermanentAddress": "string",
  "PermanentCity": "string",
  "PermanentState": "string",
  "PermanentZipCode": "string",
  "PermanentCountry": "string",
  "PermanentContactNumber": "string",
  "HomePhoneNumber": "string",
  "OfficePhoneNumber": "string",
  "MobileNumber": "string",
  "PassportNumber": "string",
  "PassportExpiration": "string"
}
}, headers = headers)

print(r.json())
<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','https://api1.webhr.co/v3/?module=Employees&submodule=Employees', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...
URL obj = new URL("https://api1.webhr.co/v3/?module=Employees&submodule=Employees?request=&data=CompanyName,string,DivisionName,string,StationName,string,DepartmentName,string,Designation,string,Grade,string,WorkShift,string,EmployeeCategory,string,EmployeeType,string,UserName,string,FirstName,string,LastName,string,Password,string,AllowLogin,string,EmailAddress,string,ShowInOrganogram,string,AccessCode,string,ReportsTo,string,Supervisor,string,Salutation,string,Nickname,string,DateofBirth,string,Gender,string,BloodGroup,string,Nationality,string,Religion,string,MaritalStatus,string,JoiningDate,string,GovernmentId,string,EmployeeTaxNumber,string,PresentAddress,string,PresentCity,string,PresentState,string,PresentZipCode,string,PresentCountry,string,PresentContactNumber,string,PermanentAddress,string,PermanentCity,string,PermanentState,string,PermanentZipCode,string,PermanentCountry,string,PermanentContactNumber,string,HomePhoneNumber,string,OfficePhoneNumber,string,MobileNumber,string,PassportNumber,string,PassportExpiration,string");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://api1.webhr.co/v3/?module=Employees&submodule=Employees", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST ?module=Employees&submodule=Employees

Adds Employees in your WebHR account

Parameters

Name In Type Required Description
request query string(varchar255) true “Add” is required in request to add employees
data query AddEmployees true JSON Array

Detailed descriptions

request: “Add” is required in request to add employees “Add” is required in request parameter to add employees

data: JSON Array “JSON Array” of employees

Example responses

Success Response

"string"

Responses

Status Meaning Description Schema
Success Unknown Message -> Employee has been addedd Successfully… string
Fail Unknown Message -> Something went wrong, Please contact your administrator… string

TransfersList

Code samples

# You can also use wget
curl -X GET https://api1.webhr.co/v3/?module=Employees&submodule=Transfers?request= \
  -H 'Accept: application/json'
GET https://api1.webhr.co/v3/?module=Employees&submodule=Transfers?request= HTTP/1.1
Host: api1.webhr.co
Accept: application/json

const headers = {
  'Accept':'application/json'
};

fetch('https://api1.webhr.co/v3/?module=Employees&submodule=Transfers?request=',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'https://api1.webhr.co/v3/?module=Employees&submodule=Transfers',
  params: {
  'request' => 'string(varchar255)'
}, headers: headers

p JSON.parse(result)
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('https://api1.webhr.co/v3/?module=Employees&submodule=Transfers', params={
  'request': ''
}, headers = headers)

print(r.json())
<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api1.webhr.co/v3/?module=Employees&submodule=Transfers', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...
URL obj = new URL("https://api1.webhr.co/v3/?module=Employees&submodule=Transfers?request=");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api1.webhr.co/v3/?module=Employees&submodule=Transfers", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET ?module=Employees&submodule=Transfers

Lists all Trasnfers in your WebHR account

Parameters

Name In Type Required Description
request query string(varchar255) true “List” is required in request parameter to fetch data from WebHR
params query TransferParams false JSON Array of parameters to get filtered data

Example responses

200 Response

{
  "Status": 1,
  "Summary": {
    "Page": 1,
    "RecordsPerPage": 10,
    "TotalRecords": 0,
    "Offset": 0,
    "NumberOfPages": 0,
    "Search": "string",
    "NextPageURL": "string"
  },
  "Data": [
    {
      "FieldId": "string",
      "DataFields": {
        "Username": "string",
        "FirstName": "string",
        "LastName": "string",
        "FullName": "string",
        "TransferDate": null,
        "TransferToStation": "string",
        "TransferToDepartment": "string",
        "OpenPositionCode": null,
        "Designation": null
      }
    }
  ]
}

Responses

Status Meaning Description Schema
200 OK OK Transfers

ExitList

Code samples

# You can also use wget
curl -X GET https://api1.webhr.co/v3/?module=Employees&submodule=Exit?request= \
  -H 'Accept: application/json'
GET https://api1.webhr.co/v3/?module=Employees&submodule=Exit?request= HTTP/1.1
Host: api1.webhr.co
Accept: application/json

const headers = {
  'Accept':'application/json'
};

fetch('https://api1.webhr.co/v3/?module=Employees&submodule=Exit?request=',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'https://api1.webhr.co/v3/?module=Employees&submodule=Exit',
  params: {
  'request' => 'string(varchar255)'
}, headers: headers

p JSON.parse(result)
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('https://api1.webhr.co/v3/?module=Employees&submodule=Exit', params={
  'request': ''
}, headers = headers)

print(r.json())
<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api1.webhr.co/v3/?module=Employees&submodule=Exit', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...
URL obj = new URL("https://api1.webhr.co/v3/?module=Employees&submodule=Exit?request=");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api1.webhr.co/v3/?module=Employees&submodule=Exit", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET ?module=Employees&submodule=Exit

Lists all Employees Exits in your WebHR account

Parameters

Name In Type Required Description
request query string(varchar255) true “List” is required in request parameter to fetch data from WebHR
params query ExitParams false JSON Array of parameters to get filtered data

Example responses

200 Response

{
  "Status": 1,
  "Summary": {
    "Page": 1,
    "RecordsPerPage": 10,
    "TotalRecords": 0,
    "Offset": 0,
    "NumberOfPages": 0,
    "Search": "string",
    "NextPageURL": "string"
  },
  "Data": [
    {
      "FieldId": "string",
      "DataFields": {
        "Username": "string",
        "FirstName": "string",
        "LastName": "string",
        "FullName": "string",
        "ExitDate": null,
        "CompanyName": "string",
        "StationName": "string",
        "DivisionName": "string",
        "ExitType": "string",
        "ExitInterviewConducted": "string"
      }
    }
  ]
}

Responses

Status Meaning Description Schema
200 OK OK Exit

ResignationsList

Code samples

# You can also use wget
curl -X GET https://api1.webhr.co/v3/?module=Employees&submodule=Resignations?request= \
  -H 'Accept: application/json'
GET https://api1.webhr.co/v3/?module=Employees&submodule=Resignations?request= HTTP/1.1
Host: api1.webhr.co
Accept: application/json

const headers = {
  'Accept':'application/json'
};

fetch('https://api1.webhr.co/v3/?module=Employees&submodule=Resignations?request=',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'https://api1.webhr.co/v3/?module=Employees&submodule=Resignations',
  params: {
  'request' => 'string(varchar255)'
}, headers: headers

p JSON.parse(result)
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('https://api1.webhr.co/v3/?module=Employees&submodule=Resignations', params={
  'request': ''
}, headers = headers)

print(r.json())
<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api1.webhr.co/v3/?module=Employees&submodule=Resignations', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...
URL obj = new URL("https://api1.webhr.co/v3/?module=Employees&submodule=Resignations?request=");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api1.webhr.co/v3/?module=Employees&submodule=Resignations", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET ?module=Employees&submodule=Resignations

Lists all Resignations in your WebHR account

Parameters

Name In Type Required Description
request query string(varchar255) true “List” is required in request parameter to fetch data from WebHR

Example responses

200 Response

{
  "Status": 1,
  "Summary": {
    "Page": 1,
    "RecordsPerPage": 10,
    "TotalRecords": 0,
    "Offset": 0,
    "NumberOfPages": 0,
    "Search": "string",
    "NextPageURL": "string"
  },
  "Data": [
    {
      "FieldId": "string",
      "DataFields": {
        "Username": "string",
        "Empoyee": "string",
        "ResignationDate": null,
        "NoticeDate": null
      }
    }
  ]
}

Responses

Status Meaning Description Schema
200 OK OK Resignations

TerminationsList

Code samples

# You can also use wget
curl -X GET https://api1.webhr.co/v3/?module=Employees&submodule=Terminations?request= \
  -H 'Accept: application/json'
GET https://api1.webhr.co/v3/?module=Employees&submodule=Terminations?request= HTTP/1.1
Host: api1.webhr.co
Accept: application/json

const headers = {
  'Accept':'application/json'
};

fetch('https://api1.webhr.co/v3/?module=Employees&submodule=Terminations?request=',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'https://api1.webhr.co/v3/?module=Employees&submodule=Terminations',
  params: {
  'request' => 'string(varchar255)'
}, headers: headers

p JSON.parse(result)
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('https://api1.webhr.co/v3/?module=Employees&submodule=Terminations', params={
  'request': ''
}, headers = headers)

print(r.json())
<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api1.webhr.co/v3/?module=Employees&submodule=Terminations', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...
URL obj = new URL("https://api1.webhr.co/v3/?module=Employees&submodule=Terminations?request=");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api1.webhr.co/v3/?module=Employees&submodule=Terminations", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET ?module=Employees&submodule=Terminations

Lists all Terminations in your WebHR account

Parameters

Name In Type Required Description
request query string(varchar255) true “List” is required in request parameter to fetch data from WebHR

Example responses

200 Response

{
  "Status": 1,
  "Summary": {
    "Page": 1,
    "RecordsPerPage": 10,
    "TotalRecords": 0,
    "Offset": 0,
    "NumberOfPages": 0,
    "Search": "string",
    "NextPageURL": "string"
  },
  "Data": [
    {
      "FieldId": "string",
      "DataFields": {
        "Username": "string",
        "Empoyee": "string",
        "TerminationType": "string",
        "TerminationDate": null,
        "NoticeDate": null
      }
    }
  ]
}

Responses

Status Meaning Description Schema
200 OK OK Terminations

AchievementsList

Code samples

# You can also use wget
curl -X GET https://api1.webhr.co/v3/?module=Employees&submodule=Achievements?request= \
  -H 'Accept: application/json'
GET https://api1.webhr.co/v3/?module=Employees&submodule=Achievements?request= HTTP/1.1
Host: api1.webhr.co
Accept: application/json

const headers = {
  'Accept':'application/json'
};

fetch('https://api1.webhr.co/v3/?module=Employees&submodule=Achievements?request=',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'https://api1.webhr.co/v3/?module=Employees&submodule=Achievements',
  params: {
  'request' => 'string(varchar255)'
}, headers: headers

p JSON.parse(result)
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('https://api1.webhr.co/v3/?module=Employees&submodule=Achievements', params={
  'request': ''
}, headers = headers)

print(r.json())
<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api1.webhr.co/v3/?module=Employees&submodule=Achievements', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...
URL obj = new URL("https://api1.webhr.co/v3/?module=Employees&submodule=Achievements?request=");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api1.webhr.co/v3/?module=Employees&submodule=Achievements", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET ?module=Employees&submodule=Achievements

Lists all Achievements in your WebHR account

Parameters

Name In Type Required Description
request query string(varchar255) true “List” is required in request parameter to fetch data from WebHR

Example responses

200 Response

{
  "Status": 1,
  "Summary": {
    "Page": 1,
    "RecordsPerPage": 10,
    "TotalRecords": 0,
    "Offset": 0,
    "NumberOfPages": 0,
    "Search": "string",
    "NextPageURL": "string"
  },
  "Data": [
    {
      "FieldId": "string",
      "DataFields": {
        "Username": "string",
        "Empoyee": "string",
        "AchievementTitle": "string",
        "AchievementDate": null
      }
    }
  ]
}

Responses

Status Meaning Description Schema
200 OK OK Achievements

ComplaintsList

Code samples

# You can also use wget
curl -X GET https://api1.webhr.co/v3/?module=Employees&submodule=Complaints?request= \
  -H 'Accept: application/json'
GET https://api1.webhr.co/v3/?module=Employees&submodule=Complaints?request= HTTP/1.1
Host: api1.webhr.co
Accept: application/json

const headers = {
  'Accept':'application/json'
};

fetch('https://api1.webhr.co/v3/?module=Employees&submodule=Complaints?request=',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'https://api1.webhr.co/v3/?module=Employees&submodule=Complaints',
  params: {
  'request' => 'string(varchar255)'
}, headers: headers

p JSON.parse(result)
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('https://api1.webhr.co/v3/?module=Employees&submodule=Complaints', params={
  'request': ''
}, headers = headers)

print(r.json())
<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api1.webhr.co/v3/?module=Employees&submodule=Complaints', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...
URL obj = new URL("https://api1.webhr.co/v3/?module=Employees&submodule=Complaints?request=");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api1.webhr.co/v3/?module=Employees&submodule=Complaints", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET ?module=Employees&submodule=Complaints

Lists all Complaints in your WebHR account

Parameters

Name In Type Required Description
request query string(varchar255) true “List” is required in request parameter to fetch data from WebHR

Example responses

200 Response

{
  "Status": 1,
  "Summary": {
    "Page": 1,
    "RecordsPerPage": 10,
    "TotalRecords": 0,
    "Offset": 0,
    "NumberOfPages": 0,
    "Search": "string",
    "NextPageURL": "string"
  },
  "Data": [
    {
      "FieldId": "string",
      "DataFields": {
        "Username": "string",
        "Empoyee": "string",
        "Title": "string",
        "ComplaintDate": null,
        "ComplaintAgainst": null
      }
    }
  ]
}

Responses

Status Meaning Description Schema
200 OK OK Complaints

WarningsList

Code samples

# You can also use wget
curl -X GET https://api1.webhr.co/v3/?module=Employees&submodule=Warnings?request= \
  -H 'Accept: application/json'
GET https://api1.webhr.co/v3/?module=Employees&submodule=Warnings?request= HTTP/1.1
Host: api1.webhr.co
Accept: application/json

const headers = {
  'Accept':'application/json'
};

fetch('https://api1.webhr.co/v3/?module=Employees&submodule=Warnings?request=',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'https://api1.webhr.co/v3/?module=Employees&submodule=Warnings',
  params: {
  'request' => 'string(varchar255)'
}, headers: headers

p JSON.parse(result)
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('https://api1.webhr.co/v3/?module=Employees&submodule=Warnings', params={
  'request': ''
}, headers = headers)

print(r.json())
<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api1.webhr.co/v3/?module=Employees&submodule=Warnings', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...
URL obj = new URL("https://api1.webhr.co/v3/?module=Employees&submodule=Warnings?request=");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api1.webhr.co/v3/?module=Employees&submodule=Warnings", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET ?module=Employees&submodule=Warnings

Lists all Warnings in your WebHR account

Parameters

Name In Type Required Description
request query string(varchar255) true “List” is required in request parameter to fetch data from WebHR

Example responses

200 Response

{
  "Status": 1,
  "Summary": {
    "Page": 1,
    "RecordsPerPage": 10,
    "TotalRecords": 0,
    "Offset": 0,
    "NumberOfPages": 0,
    "Search": "string",
    "NextPageURL": "string"
  },
  "Data": [
    {
      "FieldId": "string",
      "DataFields": {
        "WarningByEmployee": "string",
        "WarningToEmployee": "string",
        "WarningDate": null,
        "TypeOfWarning": "string",
        "Subject": "string"
      }
    }
  ]
}

Responses

Status Meaning Description Schema
200 OK OK Warnings

MemosList

Code samples

# You can also use wget
curl -X GET https://api1.webhr.co/v3/?module=Employees&submodule=Memos?request= \
  -H 'Accept: application/json'
GET https://api1.webhr.co/v3/?module=Employees&submodule=Memos?request= HTTP/1.1
Host: api1.webhr.co
Accept: application/json

const headers = {
  'Accept':'application/json'
};

fetch('https://api1.webhr.co/v3/?module=Employees&submodule=Memos?request=',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'https://api1.webhr.co/v3/?module=Employees&submodule=Memos',
  params: {
  'request' => 'string(varchar255)'
}, headers: headers

p JSON.parse(result)
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('https://api1.webhr.co/v3/?module=Employees&submodule=Memos', params={
  'request': ''
}, headers = headers)

print(r.json())
<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api1.webhr.co/v3/?module=Employees&submodule=Memos', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...
URL obj = new URL("https://api1.webhr.co/v3/?module=Employees&submodule=Memos?request=");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api1.webhr.co/v3/?module=Employees&submodule=Memos", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET ?module=Employees&submodule=Memos

Lists all Memos in your WebHR account

Parameters

Name In Type Required Description
request query string(varchar255) true “List” is required in request parameter to fetch data from WebHR

Example responses

200 Response

{
  "Status": 1,
  "Summary": {
    "Page": 1,
    "RecordsPerPage": 10,
    "TotalRecords": 0,
    "Offset": 0,
    "NumberOfPages": 0,
    "Search": "string",
    "NextPageURL": "string"
  },
  "Data": [
    {
      "FieldId": "string",
      "DataFields": {
        "UserName": "string",
        "Employee": "string",
        "MemoDate": null,
        "Subject": "string",
        "MemoTo": null
      }
    }
  ]
}

Responses

Status Meaning Description Schema
200 OK OK Memos

SuggestionsList

Code samples

# You can also use wget
curl -X GET https://api1.webhr.co/v3/?module=Employees&submodule=Suggestions?request= \
  -H 'Accept: application/json'
GET https://api1.webhr.co/v3/?module=Employees&submodule=Suggestions?request= HTTP/1.1
Host: api1.webhr.co
Accept: application/json

const headers = {
  'Accept':'application/json'
};

fetch('https://api1.webhr.co/v3/?module=Employees&submodule=Suggestions?request=',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'https://api1.webhr.co/v3/?module=Employees&submodule=Suggestions',
  params: {
  'request' => 'string(varchar255)'
}, headers: headers

p JSON.parse(result)
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('https://api1.webhr.co/v3/?module=Employees&submodule=Suggestions', params={
  'request': ''
}, headers = headers)

print(r.json())
<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api1.webhr.co/v3/?module=Employees&submodule=Suggestions', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...
URL obj = new URL("https://api1.webhr.co/v3/?module=Employees&submodule=Suggestions?request=");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api1.webhr.co/v3/?module=Employees&submodule=Suggestions", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET ?module=Employees&submodule=Suggestions

Lists all Suggestions in your WebHR account

Parameters

Name In Type Required Description
request query string(varchar255) true “List” is required in request parameter to fetch data from WebHR

Example responses

200 Response

{
  "Status": 1,
  "Summary": {
    "Page": 1,
    "RecordsPerPage": 10,
    "TotalRecords": 0,
    "Offset": 0,
    "NumberOfPages": 0,
    "Search": "string",
    "NextPageURL": "string"
  },
  "Data": [
    {
      "FieldId": "string",
      "DataFields": {
        "UserName": "string",
        "Employee": "string",
        "Title": "string"
      }
    }
  ]
}

Responses

Status Meaning Description Schema
200 OK OK Suggestions

Timesheet

AttendanceList

Code samples

# You can also use wget
curl -X GET https://api1.webhr.co/v3/?module=Timesheet&submodule=Attendance?request= \
  -H 'Accept: application/json'
GET https://api1.webhr.co/v3/?module=Timesheet&submodule=Attendance?request= HTTP/1.1
Host: api1.webhr.co
Accept: application/json

const headers = {
  'Accept':'application/json'
};

fetch('https://api1.webhr.co/v3/?module=Timesheet&submodule=Attendance?request=',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'https://api1.webhr.co/v3/?module=Timesheet&submodule=Attendance',
  params: {
  'request' => 'string(varchar255)'
}, headers: headers

p JSON.parse(result)
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('https://api1.webhr.co/v3/?module=Timesheet&submodule=Attendance', params={
  'request': ''
}, headers = headers)

print(r.json())
<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api1.webhr.co/v3/?module=Timesheet&submodule=Attendance', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...
URL obj = new URL("https://api1.webhr.co/v3/?module=Timesheet&submodule=Attendance?request=");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api1.webhr.co/v3/?module=Timesheet&submodule=Attendance", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET ?module=Timesheet&submodule=Attendance

Lists all Attendances in your WebHR account

Parameters

Name In Type Required Description
request query string(varchar255) true “List” is required in request parameter to fetch data from WebHR
params query AttendanceParams false JSON Array of parameters to get filtered data

Example responses

200 Response

{
  "Status": 1,
  "Summary": {
    "Page": 1,
    "RecordsPerPage": 10,
    "TotalRecords": 0,
    "Offset": 0,
    "NumberOfPages": 0,
    "Search": "string",
    "NextPageURL": "string"
  },
  "Data": [
    {
      "FieldId": "string",
      "DataFields": {
        "Username": "string",
        "FirstName": "string",
        "LastName": "string",
        "FullName": "string",
        "AttendanceDate": null,
        "SignInTime": null,
        "SignOutTime": null,
        "LunchBreakOutTime": null,
        "LunchBreakInTime": null,
        "AdditionalBreakOutTime": null,
        "AdditionalBreakInTime": null,
        "ExtraBreakOutTime": null,
        "ExtraBreakInTime": null,
        "BreakOutTime": null,
        "TotalTime": null,
        "ApprovalStatus": "string",
        "Approver": "string"
      }
    }
  ]
}

Responses

Status Meaning Description Schema
200 OK OK Attendance

AddAttendance

Code samples

# You can also use wget
curl -X POST https://api1.webhr.co/v3/?module=Timesheet&submodule=Attendance?request=&params=AccessCode,string,Type,string,WorkShift,string \
  -H 'Accept: application/json'
POST https://api1.webhr.co/v3/?module=Timesheet&submodule=Attendance?request=&params=AccessCode,string,Type,string,WorkShift,string HTTP/1.1
Host: api1.webhr.co
Accept: application/json

const headers = {
  'Accept':'application/json'
};

fetch('https://api1.webhr.co/v3/?module=Timesheet&submodule=Attendance?request=&params=AccessCode,string,Type,string,WorkShift,string',
{
  method: 'POST',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.post 'https://api1.webhr.co/v3/?module=Timesheet&submodule=Attendance',
  params: {
  'request' => 'string(varchar255)',
'params' => '[AddAttendance](#schemaaddattendance)'
}, headers: headers

p JSON.parse(result)
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.post('https://api1.webhr.co/v3/?module=Timesheet&submodule=Attendance', params={
  'request': '',  'params': {
  "AccessCode": "string",
  "Date": null,
  "Time": null,
  "Type": "string",
  "WorkShift": "string"
}
}, headers = headers)

print(r.json())
<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','https://api1.webhr.co/v3/?module=Timesheet&submodule=Attendance', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...
URL obj = new URL("https://api1.webhr.co/v3/?module=Timesheet&submodule=Attendance?request=&params=AccessCode,string,Type,string,WorkShift,string");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://api1.webhr.co/v3/?module=Timesheet&submodule=Attendance", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST ?module=Timesheet&submodule=Attendance

Add Leave in your WebHR account

Parameters

Name In Type Required Description
request query string(varchar255) true “Add” is required in request parameter to add Attendance
params query AddAttendance true “JSON Array” of Attendance Data.

Detailed descriptions

params: “JSON Array” of Attendance Data. Example:params={“Data”:{“AccessCode”:“8”,“Date”:“2021-04-02”,“Time”:“09:03:00”,“Type”:“Sign In”,“WorkShift”:“Regular WorkShift”}}

Example responses

Success Response

"string"

Responses

Status Meaning Description Schema
Success Unknown Message -> Records added in queue successfully. Data will be available in your WebHR account shortly. string
Fail Unknown Message -> Something went wrong, Please contact your administrator… string

LeavesList

Code samples

# You can also use wget
curl -X GET https://api1.webhr.co/v3/?module=Timesheet&submodule=Leaves?request= \
  -H 'Accept: application/json'
GET https://api1.webhr.co/v3/?module=Timesheet&submodule=Leaves?request= HTTP/1.1
Host: api1.webhr.co
Accept: application/json

const headers = {
  'Accept':'application/json'
};

fetch('https://api1.webhr.co/v3/?module=Timesheet&submodule=Leaves?request=',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'https://api1.webhr.co/v3/?module=Timesheet&submodule=Leaves',
  params: {
  'request' => 'string(varchar255)'
}, headers: headers

p JSON.parse(result)
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('https://api1.webhr.co/v3/?module=Timesheet&submodule=Leaves', params={
  'request': ''
}, headers = headers)

print(r.json())
<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api1.webhr.co/v3/?module=Timesheet&submodule=Leaves', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...
URL obj = new URL("https://api1.webhr.co/v3/?module=Timesheet&submodule=Leaves?request=");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api1.webhr.co/v3/?module=Timesheet&submodule=Leaves", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET ?module=Timesheet&submodule=Leaves

Lists all Leaves in your WebHR account

Parameters

Name In Type Required Description
request query string(varchar255) true “List” is required in request parameter to fetch data from WebHR
params query LeavesParams false JSON Array of parameters to get filtered data

Example responses

200 Response

{
  "Status": 1,
  "Summary": {
    "Page": 1,
    "RecordsPerPage": 10,
    "TotalRecords": 0,
    "Offset": 0,
    "NumberOfPages": 0,
    "Search": "string",
    "NextPageURL": "string"
  },
  "Data": [
    {
      "FieldId": "string",
      "DataFields": {
        "Username": "string",
        "FirstName": "string",
        "LastName": "string",
        "FullName": "string",
        "Reason": "string",
        "ReferenceNumber": "string",
        "LeaveType": "string",
        "LunchBreakOutTime": null,
        "LeaveFrom": null,
        "LeaveTo": null,
        "LeaveHours": "string",
        "ApprovalStatus": "string"
      }
    }
  ]
}

Responses

Status Meaning Description Schema
200 OK OK Leaves

AddLeave

Code samples

# You can also use wget
curl -X POST https://api1.webhr.co/v3/?module=Timesheet&submodule=Leaves?request=&params=UserName,string,LeaveType,string,LeaveDuration,string \
  -H 'Accept: application/json'
POST https://api1.webhr.co/v3/?module=Timesheet&submodule=Leaves?request=&params=UserName,string,LeaveType,string,LeaveDuration,string HTTP/1.1
Host: api1.webhr.co
Accept: application/json

const headers = {
  'Accept':'application/json'
};

fetch('https://api1.webhr.co/v3/?module=Timesheet&submodule=Leaves?request=&params=UserName,string,LeaveType,string,LeaveDuration,string',
{
  method: 'POST',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.post 'https://api1.webhr.co/v3/?module=Timesheet&submodule=Leaves',
  params: {
  'request' => 'string(varchar255)',
'params' => '[AddLeave](#schemaaddleave)'
}, headers: headers

p JSON.parse(result)
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.post('https://api1.webhr.co/v3/?module=Timesheet&submodule=Leaves', params={
  'request': '',  'params': {
  "UserName": "string",
  "LeaveFrom": null,
  "LeaveTo": null,
  "LeaveType": "string",
  "LeaveDuration": "string"
}
}, headers = headers)

print(r.json())
<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','https://api1.webhr.co/v3/?module=Timesheet&submodule=Leaves', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...
URL obj = new URL("https://api1.webhr.co/v3/?module=Timesheet&submodule=Leaves?request=&params=UserName,string,LeaveType,string,LeaveDuration,string");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://api1.webhr.co/v3/?module=Timesheet&submodule=Leaves", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST ?module=Timesheet&submodule=Leaves

Add Leave in your WebHR account

Parameters

Name In Type Required Description
request query string(varchar255) true “Add” is required in request to add Leave
params query AddLeave true “JSON Array” of Leave Data.

Detailed descriptions

request: “Add” is required in request to add Leave “Add” is required in request parameter to add Leave

params: “JSON Array” of Leave Data. Example:params={“UserName”:“test123”,“LeaveFrom”:“2021-04-02”,“LeaveTo”:“2021-04-04”,“LeaveType”:“Annual Leave”,“LeaveDuration”:“Full Day Leave”}

Example responses

Success Response

"string"

Responses

Status Meaning Description Schema
Success Unknown Message -> Data has been added successfully. string
Fail Unknown Message -> Something went wrong, Please contact your administrator… string

LeavesQuotaList

Code samples

# You can also use wget
curl -X GET https://api1.webhr.co/v3/?module=Timesheet&submodule=LeavesQuota?request=&params=Year,string,UserName,string,LeaveType,string \
  -H 'Accept: application/json'
GET https://api1.webhr.co/v3/?module=Timesheet&submodule=LeavesQuota?request=&params=Year,string,UserName,string,LeaveType,string HTTP/1.1
Host: api1.webhr.co
Accept: application/json

const headers = {
  'Accept':'application/json'
};

fetch('https://api1.webhr.co/v3/?module=Timesheet&submodule=LeavesQuota?request=&params=Year,string,UserName,string,LeaveType,string',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'https://api1.webhr.co/v3/?module=Timesheet&submodule=LeavesQuota',
  params: {
  'request' => 'string(varchar255)',
'params' => '[LeavesQuotaParams](#schemaleavesquotaparams)'
}, headers: headers

p JSON.parse(result)
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('https://api1.webhr.co/v3/?module=Timesheet&submodule=LeavesQuota', params={
  'request': '',  'params': {
  "Year": "string",
  "UserName": "string",
  "LeaveType": "string"
}
}, headers = headers)

print(r.json())
<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api1.webhr.co/v3/?module=Timesheet&submodule=LeavesQuota', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...
URL obj = new URL("https://api1.webhr.co/v3/?module=Timesheet&submodule=LeavesQuota?request=&params=Year,string,UserName,string,LeaveType,string");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api1.webhr.co/v3/?module=Timesheet&submodule=LeavesQuota", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET ?module=Timesheet&submodule=LeavesQuota

Lists Leaves Quota in your WebHR account

Parameters

Name In Type Required Description
request query string(varchar255) true “List” is required in request parameter to fetch data from WebHR
params query LeavesQuotaParams true JSON Array of parameters to get filtered data

Detailed descriptions

params: JSON Array of parameters to get filtered data Example:params={“Year”:“2021”, “UserName”: “jack”, “LeaveType” : “Annual Leave”}

Example responses

200 Response

{
  "Status": 1,
  "Summary": {
    "Page": 1,
    "RecordsPerPage": 10,
    "TotalRecords": 0,
    "Offset": 0,
    "NumberOfPages": 0,
    "Search": "string",
    "NextPageURL": "string"
  },
  "Data": [
    {
      "FieldId": "string",
      "DataFields": {
        "Year": "string",
        "Employee": "string",
        "UserName": "string",
        "AccessCode": "string",
        "EmployeeType": "string",
        "EmployeeCategory": null,
        "LeaveType": null,
        "Entitled": null,
        "Accrued": "string",
        "CarriedOver": "string",
        "Additional": null,
        "Adjusted": null,
        "Taken": null,
        "Pending": "string",
        "Balance": "string"
      }
    }
  ]
}

Responses

Status Meaning Description Schema
200 OK OK LeavesQuota

EmployeeHoursList

Code samples

# You can also use wget
curl -X GET https://api1.webhr.co/v3/?module=Timesheet&submodule=EmployeeHours&request=List?request= \
  -H 'Accept: application/json'
GET https://api1.webhr.co/v3/?module=Timesheet&submodule=EmployeeHours&request=List?request= HTTP/1.1
Host: api1.webhr.co
Accept: application/json

const headers = {
  'Accept':'application/json'
};

fetch('https://api1.webhr.co/v3/?module=Timesheet&submodule=EmployeeHours&request=List?request=',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'https://api1.webhr.co/v3/?module=Timesheet&submodule=EmployeeHours&request=List',
  params: {
  'request' => 'string(varchar255)'
}, headers: headers

p JSON.parse(result)
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('https://api1.webhr.co/v3/?module=Timesheet&submodule=EmployeeHours&request=List', params={
  'request': ''
}, headers = headers)

print(r.json())
<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api1.webhr.co/v3/?module=Timesheet&submodule=EmployeeHours&request=List', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...
URL obj = new URL("https://api1.webhr.co/v3/?module=Timesheet&submodule=EmployeeHours&request=List?request=");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api1.webhr.co/v3/?module=Timesheet&submodule=EmployeeHours&request=List", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET ?module=Timesheet&submodule=EmployeeHours&request=List

Lists Employee Hours in your WebHR account

Parameters

Name In Type Required Description
request query string(varchar255) true “List” is required in request parameter to fetch data from WebHR
params query EmployeeHoursParams false JSON Array of parameters to get filtered data

Example responses

200 Response

{
  "Status": 1,
  "Summary": {
    "Page": 1,
    "RecordsPerPage": 10,
    "TotalRecords": 0,
    "Offset": 0,
    "NumberOfPages": 0,
    "Search": "string",
    "NextPageURL": "string"
  },
  "Data": [
    {
      "FieldId": "string",
      "DataFields": {
        "RecordId": "string",
        "UserName": "string",
        "Employee": "string",
        "Project": "string",
        "EmployeeHoursDate": null,
        "RegularHours": 0,
        "OvertimeHours": 0
      }
    }
  ]
}

Responses

Status Meaning Description Schema
200 OK OK EmployeeHours

AddEmployeeHours

Code samples

# You can also use wget
curl -X POST https://api1.webhr.co/v3/?module=Timesheet&submodule=EmployeeHours&request=Add?request= \
  -H 'Accept: application/json'
POST https://api1.webhr.co/v3/?module=Timesheet&submodule=EmployeeHours&request=Add?request= HTTP/1.1
Host: api1.webhr.co
Accept: application/json

const headers = {
  'Accept':'application/json'
};

fetch('https://api1.webhr.co/v3/?module=Timesheet&submodule=EmployeeHours&request=Add?request=',
{
  method: 'POST',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.post 'https://api1.webhr.co/v3/?module=Timesheet&submodule=EmployeeHours&request=Add',
  params: {
  'request' => 'string(varchar255)',
'Data' => 'undefined'
}, headers: headers

p JSON.parse(result)
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.post('https://api1.webhr.co/v3/?module=Timesheet&submodule=EmployeeHours&request=Add', params={
  'request': '',  'Data': undefined
}, headers = headers)

print(r.json())
<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','https://api1.webhr.co/v3/?module=Timesheet&submodule=EmployeeHours&request=Add', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...
URL obj = new URL("https://api1.webhr.co/v3/?module=Timesheet&submodule=EmployeeHours&request=Add?request=");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://api1.webhr.co/v3/?module=Timesheet&submodule=EmployeeHours&request=Add", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST ?module=Timesheet&submodule=EmployeeHours&request=Add

Add Employee Hours in your WebHR account

Parameters

Name In Type Required Description
request query string(varchar255) true “Add” is required in request parameter to add Employee Hours
Data query undefined true “JSON Array” of Employee Hours

Detailed descriptions

Data: “JSON Array” of Employee Hours Example:Data={“UserName”:“david”,“Project”:“WebHR”,“EmployeeHoursDate”:“2022-03-20”,“RegularHours”:“8”,“OvertimeHours”:“1”}

Example responses

Success Response

"string"

Responses

Status Meaning Description Schema
Success Unknown Message -> Record addedd Successfully… string
Fail Unknown Message -> Something went wrong, Please contact your administrator… string

UpdateEmployeeHours

Code samples

# You can also use wget
curl -X POST https://api1.webhr.co/v3/?module=Timesheet&submodule=EmployeeHours&request=Update?request=&params= \
  -H 'Accept: application/json'
POST https://api1.webhr.co/v3/?module=Timesheet&submodule=EmployeeHours&request=Update?request=&params= HTTP/1.1
Host: api1.webhr.co
Accept: application/json

const headers = {
  'Accept':'application/json'
};

fetch('https://api1.webhr.co/v3/?module=Timesheet&submodule=EmployeeHours&request=Update?request=&params=',
{
  method: 'POST',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.post 'https://api1.webhr.co/v3/?module=Timesheet&submodule=EmployeeHours&request=Update',
  params: {
  'request' => 'string(varchar255)',
'params' => 'string(varchar255)',
'Data' => 'undefined'
}, headers: headers

p JSON.parse(result)
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.post('https://api1.webhr.co/v3/?module=Timesheet&submodule=EmployeeHours&request=Update', params={
  'request': '',  'params': '',  'Data': undefined
}, headers = headers)

print(r.json())
<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','https://api1.webhr.co/v3/?module=Timesheet&submodule=EmployeeHours&request=Update', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...
URL obj = new URL("https://api1.webhr.co/v3/?module=Timesheet&submodule=EmployeeHours&request=Update?request=&params=");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://api1.webhr.co/v3/?module=Timesheet&submodule=EmployeeHours&request=Update", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST ?module=Timesheet&submodule=EmployeeHours&request=Update

Update Employee Hours in your WebHR account

Parameters

Name In Type Required Description
request query string(varchar255) true “Update” is required in request parameter to update Employee Hours
params query string(varchar255) true JSON Object of parameters containing FieldId returned in list API.
Data query undefined true “JSON Array” of Employee Hours

Detailed descriptions

params: JSON Object of parameters containing FieldId returned in list API. Example:params={“FieldId”:“WyI2OTQiLCJDdG1IcUoiXQ==”}

Data: “JSON Array” of Employee Hours Example:Data={“UserName”:“david”,“Project”:“WebHR”,“EmployeeHoursDate”:“2022-03-20”,“RegularHours”:“8”,“OvertimeHours”:“1”}

Example responses

Success Response

"string"

Responses

Status Meaning Description Schema
Success Unknown Message -> Record Updated Successfully… string
Fail Unknown Message -> Something went wrong, Please contact your administrator… string

DeleteEmployeeHours

Code samples

# You can also use wget
curl -X POST https://api1.webhr.co/v3/?module=Timesheet&submodule=EmployeeHours&request=Delete?request=&params= \
  -H 'Accept: application/json'
POST https://api1.webhr.co/v3/?module=Timesheet&submodule=EmployeeHours&request=Delete?request=&params= HTTP/1.1
Host: api1.webhr.co
Accept: application/json

const headers = {
  'Accept':'application/json'
};

fetch('https://api1.webhr.co/v3/?module=Timesheet&submodule=EmployeeHours&request=Delete?request=&params=',
{
  method: 'POST',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.post 'https://api1.webhr.co/v3/?module=Timesheet&submodule=EmployeeHours&request=Delete',
  params: {
  'request' => 'string(varchar255)',
'params' => 'string(varchar255)'
}, headers: headers

p JSON.parse(result)
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.post('https://api1.webhr.co/v3/?module=Timesheet&submodule=EmployeeHours&request=Delete', params={
  'request': '',  'params': ''
}, headers = headers)

print(r.json())
<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','https://api1.webhr.co/v3/?module=Timesheet&submodule=EmployeeHours&request=Delete', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...
URL obj = new URL("https://api1.webhr.co/v3/?module=Timesheet&submodule=EmployeeHours&request=Delete?request=&params=");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://api1.webhr.co/v3/?module=Timesheet&submodule=EmployeeHours&request=Delete", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST ?module=Timesheet&submodule=EmployeeHours&request=Delete

Delete Employee Hours in your WebHR account

Parameters

Name In Type Required Description
request query string(varchar255) true “Delete” is required in request to delete Employee Hours
params query string(varchar255) true JSON Object of parameters containing FieldId returned in list API.

Detailed descriptions

request: “Delete” is required in request to delete Employee Hours “Delete” is required in request parameter to delete Employee Hours

params: JSON Object of parameters containing FieldId returned in list API. Example:params={“FieldId”:“WyI2OTQiLCJDdG1IcUoiXQ==”}

Example responses

Success Response

"string"

Responses

Status Meaning Description Schema
Success Unknown Message -> Record Deleted Successfully… string
Fail Unknown Message -> Something went wrong, Please contact your administrator… string

Projects

ProjectsList

Code samples

# You can also use wget
curl -X GET https://api1.webhr.co/v3/?module=Projects&submodule=Projects&request=List?request= \
  -H 'Accept: application/json'
GET https://api1.webhr.co/v3/?module=Projects&submodule=Projects&request=List?request= HTTP/1.1
Host: api1.webhr.co
Accept: application/json

const headers = {
  'Accept':'application/json'
};

fetch('https://api1.webhr.co/v3/?module=Projects&submodule=Projects&request=List?request=',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'https://api1.webhr.co/v3/?module=Projects&submodule=Projects&request=List',
  params: {
  'request' => 'string(varchar255)'
}, headers: headers

p JSON.parse(result)
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('https://api1.webhr.co/v3/?module=Projects&submodule=Projects&request=List', params={
  'request': ''
}, headers = headers)

print(r.json())
<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api1.webhr.co/v3/?module=Projects&submodule=Projects&request=List', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...
URL obj = new URL("https://api1.webhr.co/v3/?module=Projects&submodule=Projects&request=List?request=");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api1.webhr.co/v3/?module=Projects&submodule=Projects&request=List", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET ?module=Projects&submodule=Projects&request=List

Lists Projects in your WebHR account

Parameters

Name In Type Required Description
request query string(varchar255) true “List” is required in request parameter to fetch data from WebHR

Example responses

200 Response

{
  "Status": 1,
  "Summary": {
    "Page": 1,
    "RecordsPerPage": 10,
    "TotalRecords": 0,
    "Offset": 0,
    "NumberOfPages": 0,
    "Search": "string",
    "NextPageURL": "string"
  },
  "Data": [
    {
      "FieldId": "string",
      "DataFields": {
        "RecordId": "string",
        "ProjectTitle": "string",
        "ProjectCode": "string",
        "ClientName": "string",
        "ProjectCategoryName": null,
        "ProjectStartDate": null,
        "ProjectEndDate": null,
        "ProjectManager": "string",
        "ProjectCoordinator": "string",
        "ProjectEmployees": "string"
      }
    }
  ]
}

Responses

Status Meaning Description Schema
200 OK OK Projects

AddProjects

Code samples

# You can also use wget
curl -X POST https://api1.webhr.co/v3/?module=Projects&submodule=Projects&request=Add?request=&Data=Status,1,Summary,%5Bobject%20Object%5D,Data,%5Bobject%20Object%5D \
  -H 'Accept: application/json'
POST https://api1.webhr.co/v3/?module=Projects&submodule=Projects&request=Add?request=&Data=Status,1,Summary,%5Bobject%20Object%5D,Data,%5Bobject%20Object%5D HTTP/1.1
Host: api1.webhr.co
Accept: application/json

const headers = {
  'Accept':'application/json'
};

fetch('https://api1.webhr.co/v3/?module=Projects&submodule=Projects&request=Add?request=&Data=Status,1,Summary,%5Bobject%20Object%5D,Data,%5Bobject%20Object%5D',
{
  method: 'POST',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.post 'https://api1.webhr.co/v3/?module=Projects&submodule=Projects&request=Add',
  params: {
  'request' => 'string(varchar255)',
'Data' => '[Projects](#schemaprojects)'
}, headers: headers

p JSON.parse(result)
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.post('https://api1.webhr.co/v3/?module=Projects&submodule=Projects&request=Add', params={
  'request': '',  'Data': {
  "Status": 1,
  "Summary": {
    "Page": 1,
    "RecordsPerPage": 10,
    "TotalRecords": 0,
    "Offset": 0,
    "NumberOfPages": 0,
    "Search": "string",
    "NextPageURL": "string"
  },
  "Data": [
    {
      "FieldId": "string",
      "DataFields": {
        "RecordId": "string",
        "ProjectTitle": "string",
        "ProjectCode": "string",
        "ClientName": "string",
        "ProjectCategoryName": null,
        "ProjectStartDate": null,
        "ProjectEndDate": null,
        "ProjectManager": "string",
        "ProjectCoordinator": "string",
        "ProjectEmployees": "string"
      }
    }
  ]
}
}, headers = headers)

print(r.json())
<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','https://api1.webhr.co/v3/?module=Projects&submodule=Projects&request=Add', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...
URL obj = new URL("https://api1.webhr.co/v3/?module=Projects&submodule=Projects&request=Add?request=&Data=Status,1,Summary,%5Bobject%20Object%5D,Data,%5Bobject%20Object%5D");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://api1.webhr.co/v3/?module=Projects&submodule=Projects&request=Add", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST ?module=Projects&submodule=Projects&request=Add

Add Projects in your WebHR account

Parameters

Name In Type Required Description
request query string(varchar255) true “Add” is required in request parameter to add Projects
Data query Projects true “JSON Array” of Data

Detailed descriptions

Data: “JSON Array” of Data Example:Data={“ProjectTitle”:“Test API Project”, “ProjectEmployees”:[“admin”]}

Example responses

Success Response

"string"

Responses

Status Meaning Description Schema
Success Unknown Message -> Record addedd Successfully… string
Fail Unknown Message -> Something went wrong, Please contact your administrator… string

UpdateProjects

Code samples

# You can also use wget
curl -X POST https://api1.webhr.co/v3/?module=Projects&submodule=Projects&request=Update?request=&params=&Data=Status,1,Summary,%5Bobject%20Object%5D,Data,%5Bobject%20Object%5D \
  -H 'Accept: application/json'
POST https://api1.webhr.co/v3/?module=Projects&submodule=Projects&request=Update?request=&params=&Data=Status,1,Summary,%5Bobject%20Object%5D,Data,%5Bobject%20Object%5D HTTP/1.1
Host: api1.webhr.co
Accept: application/json

const headers = {
  'Accept':'application/json'
};

fetch('https://api1.webhr.co/v3/?module=Projects&submodule=Projects&request=Update?request=&params=&Data=Status,1,Summary,%5Bobject%20Object%5D,Data,%5Bobject%20Object%5D',
{
  method: 'POST',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.post 'https://api1.webhr.co/v3/?module=Projects&submodule=Projects&request=Update',
  params: {
  'request' => 'string(varchar255)',
'params' => 'string(varchar255)',
'Data' => '[Projects](#schemaprojects)'
}, headers: headers

p JSON.parse(result)
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.post('https://api1.webhr.co/v3/?module=Projects&submodule=Projects&request=Update', params={
  'request': '',  'params': '',  'Data': {
  "Status": 1,
  "Summary": {
    "Page": 1,
    "RecordsPerPage": 10,
    "TotalRecords": 0,
    "Offset": 0,
    "NumberOfPages": 0,
    "Search": "string",
    "NextPageURL": "string"
  },
  "Data": [
    {
      "FieldId": "string",
      "DataFields": {
        "RecordId": "string",
        "ProjectTitle": "string",
        "ProjectCode": "string",
        "ClientName": "string",
        "ProjectCategoryName": null,
        "ProjectStartDate": null,
        "ProjectEndDate": null,
        "ProjectManager": "string",
        "ProjectCoordinator": "string",
        "ProjectEmployees": "string"
      }
    }
  ]
}
}, headers = headers)

print(r.json())
<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','https://api1.webhr.co/v3/?module=Projects&submodule=Projects&request=Update', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...
URL obj = new URL("https://api1.webhr.co/v3/?module=Projects&submodule=Projects&request=Update?request=&params=&Data=Status,1,Summary,%5Bobject%20Object%5D,Data,%5Bobject%20Object%5D");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://api1.webhr.co/v3/?module=Projects&submodule=Projects&request=Update", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST ?module=Projects&submodule=Projects&request=Update

Update Projects in your WebHR account

Parameters

Name In Type Required Description
request query string(varchar255) true “Update” is required in request parameter to add Projects
params query string(varchar255) true JSON Object of parameters containing FieldId returned in list API.
Data query Projects true “JSON Array” of Data

Detailed descriptions

params: JSON Object of parameters containing FieldId returned in list API. Example:params={“FieldId”:“WyI2OTQiLCJDdG1IcUoiXQ==”}

Data: “JSON Array” of Data Example:Data={“ProjectTitle”:“Test API Project”, “ProjectEmployees”:[“admin”]}

Example responses

Success Response

"string"

Responses

Status Meaning Description Schema
Success Unknown Message -> Record Updated Successfully… string
Fail Unknown Message -> Something went wrong, Please contact your administrator… string

DeleteProjects

Code samples

# You can also use wget
curl -X POST https://api1.webhr.co/v3/?module=Projects&submodule=Projects&request=Delete?request= \
  -H 'Accept: application/json'
POST https://api1.webhr.co/v3/?module=Projects&submodule=Projects&request=Delete?request= HTTP/1.1
Host: api1.webhr.co
Accept: application/json

const headers = {
  'Accept':'application/json'
};

fetch('https://api1.webhr.co/v3/?module=Projects&submodule=Projects&request=Delete?request=',
{
  method: 'POST',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.post 'https://api1.webhr.co/v3/?module=Projects&submodule=Projects&request=Delete',
  params: {
  'request' => 'string(varchar255)'
}, headers: headers

p JSON.parse(result)
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.post('https://api1.webhr.co/v3/?module=Projects&submodule=Projects&request=Delete', params={
  'request': ''
}, headers = headers)

print(r.json())
<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','https://api1.webhr.co/v3/?module=Projects&submodule=Projects&request=Delete', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...
URL obj = new URL("https://api1.webhr.co/v3/?module=Projects&submodule=Projects&request=Delete?request=");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://api1.webhr.co/v3/?module=Projects&submodule=Projects&request=Delete", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST ?module=Projects&submodule=Projects&request=Delete

Delete Projects from your WebHR account

Parameters

Name In Type Required Description
request query string(varchar255) true “Delete” is required in request parameter to add Projects
params query undefined false “JSON Array” of params

Detailed descriptions

params: “JSON Array” of params Example:params={“RecordId”:“xyz”}

Example responses

Success Response

"string"

Responses

Status Meaning Description Schema
Success Unknown Message -> Record Delete Successfully… string
Fail Unknown Message -> Something went wrong, Please contact your administrator… string

ProjectsTasksList

Code samples

# You can also use wget
curl -X GET https://api1.webhr.co/v3/?module=Projects&submodule=ProjectsTasks&request=List?request= \
  -H 'Accept: application/json'
GET https://api1.webhr.co/v3/?module=Projects&submodule=ProjectsTasks&request=List?request= HTTP/1.1
Host: api1.webhr.co
Accept: application/json

const headers = {
  'Accept':'application/json'
};

fetch('https://api1.webhr.co/v3/?module=Projects&submodule=ProjectsTasks&request=List?request=',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'https://api1.webhr.co/v3/?module=Projects&submodule=ProjectsTasks&request=List',
  params: {
  'request' => 'string(varchar255)'
}, headers: headers

p JSON.parse(result)
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('https://api1.webhr.co/v3/?module=Projects&submodule=ProjectsTasks&request=List', params={
  'request': ''
}, headers = headers)

print(r.json())
<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api1.webhr.co/v3/?module=Projects&submodule=ProjectsTasks&request=List', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...
URL obj = new URL("https://api1.webhr.co/v3/?module=Projects&submodule=ProjectsTasks&request=List?request=");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api1.webhr.co/v3/?module=Projects&submodule=ProjectsTasks&request=List", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET ?module=Projects&submodule=ProjectsTasks&request=List

Lists Projects Tasks in your WebHR account

Parameters

Name In Type Required Description
request query string(varchar255) true “List” is required in request parameter to fetch data from WebHR

Example responses

200 Response

{
  "Status": 1,
  "Summary": {
    "Page": 1,
    "RecordsPerPage": 10,
    "TotalRecords": 0,
    "Offset": 0,
    "NumberOfPages": 0,
    "Search": "string",
    "NextPageURL": "string"
  },
  "Data": [
    {
      "FieldId": "string",
      "DataFields": {
        "Task": "string",
        "TaskType": "string",
        "ProjectTitle": "string",
        "ClientName": "string",
        "TaskStartDate": null,
        "TaskEndDate": null,
        "Deadline": null,
        "AssignedTo": []
      }
    }
  ]
}

Responses

Status Meaning Description Schema
200 OK OK ProjectsTasks

AddProjectsTasks

Code samples

# You can also use wget
curl -X POST https://api1.webhr.co/v3/?module=Projects&submodule=ProjectsTasks&request=Add?request=&Data=Task,string,TaskType,string,ProjectTitle,string,AssignedTo,,TaskStartTime,string,TaskEndTime,string,MaxHoursBy,string,MaxHours,string,TaskRateRegular,string,TaskRateOvertime,string,TaskBillRateRegular,string,TaskBillRateOvertime,string,Description,string \
  -H 'Accept: application/json'
POST https://api1.webhr.co/v3/?module=Projects&submodule=ProjectsTasks&request=Add?request=&Data=Task,string,TaskType,string,ProjectTitle,string,AssignedTo,,TaskStartTime,string,TaskEndTime,string,MaxHoursBy,string,MaxHours,string,TaskRateRegular,string,TaskRateOvertime,string,TaskBillRateRegular,string,TaskBillRateOvertime,string,Description,string HTTP/1.1
Host: api1.webhr.co
Accept: application/json

const headers = {
  'Accept':'application/json'
};

fetch('https://api1.webhr.co/v3/?module=Projects&submodule=ProjectsTasks&request=Add?request=&Data=Task,string,TaskType,string,ProjectTitle,string,AssignedTo,,TaskStartTime,string,TaskEndTime,string,MaxHoursBy,string,MaxHours,string,TaskRateRegular,string,TaskRateOvertime,string,TaskBillRateRegular,string,TaskBillRateOvertime,string,Description,string',
{
  method: 'POST',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.post 'https://api1.webhr.co/v3/?module=Projects&submodule=ProjectsTasks&request=Add',
  params: {
  'request' => 'string(varchar255)',
'Data' => '[ProjectsTasksParams](#schemaprojectstasksparams)'
}, headers: headers

p JSON.parse(result)
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.post('https://api1.webhr.co/v3/?module=Projects&submodule=ProjectsTasks&request=Add', params={
  'request': '',  'Data': {
  "Task": "string",
  "TaskType": "string",
  "ProjectTitle": "string",
  "Deadline": null,
  "AssignedTo": [],
  "TaskStartDate": null,
  "TaskEndDate": null,
  "TaskStartTime": "string",
  "TaskEndTime": "string",
  "MaxHoursBy": "string",
  "MaxHours": "string",
  "TaskRateRegular": "string",
  "TaskRateOvertime": "string",
  "TaskBillRateRegular": "string",
  "TaskBillRateOvertime": "string",
  "Description": "string"
}
}, headers = headers)

print(r.json())
<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','https://api1.webhr.co/v3/?module=Projects&submodule=ProjectsTasks&request=Add', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...
URL obj = new URL("https://api1.webhr.co/v3/?module=Projects&submodule=ProjectsTasks&request=Add?request=&Data=Task,string,TaskType,string,ProjectTitle,string,AssignedTo,,TaskStartTime,string,TaskEndTime,string,MaxHoursBy,string,MaxHours,string,TaskRateRegular,string,TaskRateOvertime,string,TaskBillRateRegular,string,TaskBillRateOvertime,string,Description,string");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://api1.webhr.co/v3/?module=Projects&submodule=ProjectsTasks&request=Add", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST ?module=Projects&submodule=ProjectsTasks&request=Add

Add Projects Tasks in your WebHR account

Parameters

Name In Type Required Description
request query string(varchar255) true “Add” is required in request parameter to add Project Tasks
Data query ProjectsTasksParams true “JSON Array” of Project Tasks

Detailed descriptions

Data: “JSON Array” of Project Tasks Example:Data={“ProjectTitle”: “My Project”, “TaskType”:“Team Task”, “TaskTitle”: “Testing Task”, “AssignTo”: [“cruz”, “sophia”]}

Example responses

Success Response

"string"

Responses

Status Meaning Description Schema
Success Unknown Message -> Record addedd Successfully… string
Fail Unknown Message -> Something went wrong, Please contact your administrator… string

UpdateProjectsTasks

Code samples

# You can also use wget
curl -X POST https://api1.webhr.co/v3/?module=Projects&submodule=ProjectsTasks&request==Update?request=&params=&Data=Task,string,TaskType,string,ProjectTitle,string,AssignedTo,,TaskStartTime,string,TaskEndTime,string,MaxHoursBy,string,MaxHours,string,TaskRateRegular,string,TaskRateOvertime,string,TaskBillRateRegular,string,TaskBillRateOvertime,string,Description,string \
  -H 'Accept: application/json'
POST https://api1.webhr.co/v3/?module=Projects&submodule=ProjectsTasks&request==Update?request=&params=&Data=Task,string,TaskType,string,ProjectTitle,string,AssignedTo,,TaskStartTime,string,TaskEndTime,string,MaxHoursBy,string,MaxHours,string,TaskRateRegular,string,TaskRateOvertime,string,TaskBillRateRegular,string,TaskBillRateOvertime,string,Description,string HTTP/1.1
Host: api1.webhr.co
Accept: application/json

const headers = {
  'Accept':'application/json'
};

fetch('https://api1.webhr.co/v3/?module=Projects&submodule=ProjectsTasks&request==Update?request=&params=&Data=Task,string,TaskType,string,ProjectTitle,string,AssignedTo,,TaskStartTime,string,TaskEndTime,string,MaxHoursBy,string,MaxHours,string,TaskRateRegular,string,TaskRateOvertime,string,TaskBillRateRegular,string,TaskBillRateOvertime,string,Description,string',
{
  method: 'POST',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.post 'https://api1.webhr.co/v3/?module=Projects&submodule=ProjectsTasks&request==Update',
  params: {
  'request' => 'string(varchar255)',
'params' => 'string(varchar255)',
'Data' => '[ProjectsTasksParams](#schemaprojectstasksparams)'
}, headers: headers

p JSON.parse(result)
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.post('https://api1.webhr.co/v3/?module=Projects&submodule=ProjectsTasks&request==Update', params={
  'request': '',  'params': '',  'Data': {
  "Task": "string",
  "TaskType": "string",
  "ProjectTitle": "string",
  "Deadline": null,
  "AssignedTo": [],
  "TaskStartDate": null,
  "TaskEndDate": null,
  "TaskStartTime": "string",
  "TaskEndTime": "string",
  "MaxHoursBy": "string",
  "MaxHours": "string",
  "TaskRateRegular": "string",
  "TaskRateOvertime": "string",
  "TaskBillRateRegular": "string",
  "TaskBillRateOvertime": "string",
  "Description": "string"
}
}, headers = headers)

print(r.json())
<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','https://api1.webhr.co/v3/?module=Projects&submodule=ProjectsTasks&request==Update', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...
URL obj = new URL("https://api1.webhr.co/v3/?module=Projects&submodule=ProjectsTasks&request==Update?request=&params=&Data=Task,string,TaskType,string,ProjectTitle,string,AssignedTo,,TaskStartTime,string,TaskEndTime,string,MaxHoursBy,string,MaxHours,string,TaskRateRegular,string,TaskRateOvertime,string,TaskBillRateRegular,string,TaskBillRateOvertime,string,Description,string");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://api1.webhr.co/v3/?module=Projects&submodule=ProjectsTasks&request==Update", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST ?module=Projects&submodule=ProjectsTasks&request==Update

Add Projects Tasks in your WebHR account

Parameters

Name In Type Required Description
request query string(varchar255) true “Update” is required in request parameter to add Project Tasks
params query string(varchar255) true JSON Object of parameters containing FieldId returned in list API.
Data query ProjectsTasksParams true “JSON Array” of Project Tasks

Detailed descriptions

params: JSON Object of parameters containing FieldId returned in list API. Example:params={“FieldId”:“WyI2OTQiLCJDdG1IcUoiXQ==”}

Data: “JSON Array” of Project Tasks Example:Data={“ProjectTitle”: “My Project”, “TaskType”:“Team Task”, “TaskTitle”: “Testing Task”, “AssignTo”: [“cruz”, “sophia”]}

Example responses

Success Response

"string"

Responses

Status Meaning Description Schema
Success Unknown Message -> Record Updated Successfully… string
Fail Unknown Message -> Something went wrong, Please contact your administrator… string

DeleteProjectsTasks

Code samples

# You can also use wget
curl -X GET https://api1.webhr.co/v3/?module=Projects&submodule=ProjectsTasks&request=Delete?request=&params= \
  -H 'Accept: application/json'
GET https://api1.webhr.co/v3/?module=Projects&submodule=ProjectsTasks&request=Delete?request=&params= HTTP/1.1
Host: api1.webhr.co
Accept: application/json

const headers = {
  'Accept':'application/json'
};

fetch('https://api1.webhr.co/v3/?module=Projects&submodule=ProjectsTasks&request=Delete?request=&params=',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'https://api1.webhr.co/v3/?module=Projects&submodule=ProjectsTasks&request=Delete',
  params: {
  'request' => 'string(varchar255)',
'params' => 'string(varchar255)'
}, headers: headers

p JSON.parse(result)
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('https://api1.webhr.co/v3/?module=Projects&submodule=ProjectsTasks&request=Delete', params={
  'request': '',  'params': ''
}, headers = headers)

print(r.json())
<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api1.webhr.co/v3/?module=Projects&submodule=ProjectsTasks&request=Delete', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...
URL obj = new URL("https://api1.webhr.co/v3/?module=Projects&submodule=ProjectsTasks&request=Delete?request=&params=");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api1.webhr.co/v3/?module=Projects&submodule=ProjectsTasks&request=Delete", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET ?module=Projects&submodule=ProjectsTasks&request=Delete

Delete Projects Tasks in your WebHR account

Parameters

Name In Type Required Description
request query string(varchar255) true “Delete” is required in request parameter to Delete Projects Tasks
params query string(varchar255) true JSON Object of parameters containing FieldId returned in list API.

Detailed descriptions

params: JSON Object of parameters containing FieldId returned in list API. Example:params={“FieldId”:“WyI2OTQiLCJDdG1IcUoiXQ==”}

Example responses

Success Response

"string"

Responses

Status Meaning Description Schema
Success Unknown Message -> Record Deleted Successfully… string
Fail Unknown Message -> Something went wrong, Please contact your administrator… string

ProjectsClientsList

Code samples

# You can also use wget
curl -X GET https://api1.webhr.co/v3/?module=Projects&submodule=ProjectsClients&request=List?request= \
  -H 'Accept: application/json'
GET https://api1.webhr.co/v3/?module=Projects&submodule=ProjectsClients&request=List?request= HTTP/1.1
Host: api1.webhr.co
Accept: application/json

const headers = {
  'Accept':'application/json'
};

fetch('https://api1.webhr.co/v3/?module=Projects&submodule=ProjectsClients&request=List?request=',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'https://api1.webhr.co/v3/?module=Projects&submodule=ProjectsClients&request=List',
  params: {
  'request' => 'string(varchar255)'
}, headers: headers

p JSON.parse(result)
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('https://api1.webhr.co/v3/?module=Projects&submodule=ProjectsClients&request=List', params={
  'request': ''
}, headers = headers)

print(r.json())
<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api1.webhr.co/v3/?module=Projects&submodule=ProjectsClients&request=List', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...
URL obj = new URL("https://api1.webhr.co/v3/?module=Projects&submodule=ProjectsClients&request=List?request=");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api1.webhr.co/v3/?module=Projects&submodule=ProjectsClients&request=List", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET ?module=Projects&submodule=ProjectsClients&request=List

Lists Projects Clients in your WebHR account

Parameters

Name In Type Required Description
request query string(varchar255) true “List” is required in request parameter to fetch data from WebHR

Example responses

200 Response

{
  "Status": 1,
  "Summary": {
    "Page": 1,
    "RecordsPerPage": 10,
    "TotalRecords": 0,
    "Offset": 0,
    "NumberOfPages": 0,
    "Search": "string",
    "NextPageURL": "string"
  },
  "Data": [
    {
      "FieldId": "string",
      "DataFields": {
        "ClientName": "string",
        "FirstName": "string",
        "LastName": "string",
        "EmailAddress": "string",
        "PhoneNumber": "string",
        "Address": "string",
        "City": "string",
        "State": "string",
        "Country": "string",
        "ZipCode": "string"
      }
    }
  ]
}

Responses

Status Meaning Description Schema
200 OK OK ProjectsClients

AddProjectsClients

Code samples

# You can also use wget
curl -X POST https://api1.webhr.co/v3/?module=Projects&submodule=ProjectsClients&request=Add?request=&Data=ClientName,string,FirstName,string,LastName,string,EmailAddress,string,PhoneNumber,string,Address,string,City,string,State,string,Country,string,ZipCode,string \
  -H 'Accept: application/json'
POST https://api1.webhr.co/v3/?module=Projects&submodule=ProjectsClients&request=Add?request=&Data=ClientName,string,FirstName,string,LastName,string,EmailAddress,string,PhoneNumber,string,Address,string,City,string,State,string,Country,string,ZipCode,string HTTP/1.1
Host: api1.webhr.co
Accept: application/json

const headers = {
  'Accept':'application/json'
};

fetch('https://api1.webhr.co/v3/?module=Projects&submodule=ProjectsClients&request=Add?request=&Data=ClientName,string,FirstName,string,LastName,string,EmailAddress,string,PhoneNumber,string,Address,string,City,string,State,string,Country,string,ZipCode,string',
{
  method: 'POST',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.post 'https://api1.webhr.co/v3/?module=Projects&submodule=ProjectsClients&request=Add',
  params: {
  'request' => 'string(varchar255)',
'Data' => '[ProjectsClientsDataFields](#schemaprojectsclientsdatafields)'
}, headers: headers

p JSON.parse(result)
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.post('https://api1.webhr.co/v3/?module=Projects&submodule=ProjectsClients&request=Add', params={
  'request': '',  'Data': {
  "ClientName": "string",
  "FirstName": "string",
  "LastName": "string",
  "EmailAddress": "string",
  "PhoneNumber": "string",
  "Address": "string",
  "City": "string",
  "State": "string",
  "Country": "string",
  "ZipCode": "string"
}
}, headers = headers)

print(r.json())
<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','https://api1.webhr.co/v3/?module=Projects&submodule=ProjectsClients&request=Add', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...
URL obj = new URL("https://api1.webhr.co/v3/?module=Projects&submodule=ProjectsClients&request=Add?request=&Data=ClientName,string,FirstName,string,LastName,string,EmailAddress,string,PhoneNumber,string,Address,string,City,string,State,string,Country,string,ZipCode,string");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://api1.webhr.co/v3/?module=Projects&submodule=ProjectsClients&request=Add", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST ?module=Projects&submodule=ProjectsClients&request=Add

Add Projects Clients in your WebHR account

Parameters

Name In Type Required Description
request query string(varchar255) true “Add” is required in request parameter to add Projects Clients
Data query ProjectsClientsDataFields true “JSON Array” of Projects Clients

Detailed descriptions

Data: “JSON Array” of Projects Clients Example:Data={“ClientName”: “Verge Inc”, “FirstName”: “Verge”, “LastName”: “Systems”}

Example responses

Success Response

"string"

Responses

Status Meaning Description Schema
Success Unknown Message -> Record added Successfully… string
Fail Unknown Message -> Something went wrong, Please contact your administrator… string

UpdateProjectsClients

Code samples

# You can also use wget
curl -X POST https://api1.webhr.co/v3/?module=Projects&submodule=ProjectsClients&request=Update?request=&params=&Data=ClientName,string,FirstName,string,LastName,string,EmailAddress,string,PhoneNumber,string,Address,string,City,string,State,string,Country,string,ZipCode,string \
  -H 'Accept: application/json'
POST https://api1.webhr.co/v3/?module=Projects&submodule=ProjectsClients&request=Update?request=&params=&Data=ClientName,string,FirstName,string,LastName,string,EmailAddress,string,PhoneNumber,string,Address,string,City,string,State,string,Country,string,ZipCode,string HTTP/1.1
Host: api1.webhr.co
Accept: application/json

const headers = {
  'Accept':'application/json'
};

fetch('https://api1.webhr.co/v3/?module=Projects&submodule=ProjectsClients&request=Update?request=&params=&Data=ClientName,string,FirstName,string,LastName,string,EmailAddress,string,PhoneNumber,string,Address,string,City,string,State,string,Country,string,ZipCode,string',
{
  method: 'POST',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.post 'https://api1.webhr.co/v3/?module=Projects&submodule=ProjectsClients&request=Update',
  params: {
  'request' => 'string(varchar255)',
'params' => 'string(varchar255)',
'Data' => '[ProjectsClientsDataFields](#schemaprojectsclientsdatafields)'
}, headers: headers

p JSON.parse(result)
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.post('https://api1.webhr.co/v3/?module=Projects&submodule=ProjectsClients&request=Update', params={
  'request': '',  'params': '',  'Data': {
  "ClientName": "string",
  "FirstName": "string",
  "LastName": "string",
  "EmailAddress": "string",
  "PhoneNumber": "string",
  "Address": "string",
  "City": "string",
  "State": "string",
  "Country": "string",
  "ZipCode": "string"
}
}, headers = headers)

print(r.json())
<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','https://api1.webhr.co/v3/?module=Projects&submodule=ProjectsClients&request=Update', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...
URL obj = new URL("https://api1.webhr.co/v3/?module=Projects&submodule=ProjectsClients&request=Update?request=&params=&Data=ClientName,string,FirstName,string,LastName,string,EmailAddress,string,PhoneNumber,string,Address,string,City,string,State,string,Country,string,ZipCode,string");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://api1.webhr.co/v3/?module=Projects&submodule=ProjectsClients&request=Update", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST ?module=Projects&submodule=ProjectsClients&request=Update

Update Projects Clients in your WebHR account

Parameters

Name In Type Required Description
request query string(varchar255) true “Update” is required in request parameter to Update Projects Clients
params query string(varchar255) true JSON Object of parameters containing FieldId returned in list API.
Data query ProjectsClientsDataFields true “JSON Array” of Data

Detailed descriptions

params: JSON Object of parameters containing FieldId returned in list API. Example:params={“FieldId”:“WyI2OTQiLCJDdG1IcUoiXQ==”}

Data: “JSON Array” of Data Example:Data={“ClientName”: “Verge Inc”, “FirstName”: “Verge”, “LastName”: “Systems”}

Example responses

Success Response

"string"

Responses

Status Meaning Description Schema
Success Unknown Message -> Record Updated Successfully… string
Fail Unknown Message -> Something went wrong, Please contact your administrator… string

DeleteProjectsClients

Code samples

# You can also use wget
curl -X GET https://api1.webhr.co/v3/?module=Projects&submodule=ProjectsClients&request=Delete?request=&params= \
  -H 'Accept: application/json'
GET https://api1.webhr.co/v3/?module=Projects&submodule=ProjectsClients&request=Delete?request=&params= HTTP/1.1
Host: api1.webhr.co
Accept: application/json

const headers = {
  'Accept':'application/json'
};

fetch('https://api1.webhr.co/v3/?module=Projects&submodule=ProjectsClients&request=Delete?request=&params=',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'https://api1.webhr.co/v3/?module=Projects&submodule=ProjectsClients&request=Delete',
  params: {
  'request' => 'string(varchar255)',
'params' => 'string(varchar255)'
}, headers: headers

p JSON.parse(result)
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('https://api1.webhr.co/v3/?module=Projects&submodule=ProjectsClients&request=Delete', params={
  'request': '',  'params': ''
}, headers = headers)

print(r.json())
<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api1.webhr.co/v3/?module=Projects&submodule=ProjectsClients&request=Delete', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...
URL obj = new URL("https://api1.webhr.co/v3/?module=Projects&submodule=ProjectsClients&request=Delete?request=&params=");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api1.webhr.co/v3/?module=Projects&submodule=ProjectsClients&request=Delete", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET ?module=Projects&submodule=ProjectsClients&request=Delete

Delete Projects Clients in your WebHR account

Parameters

Name In Type Required Description
request query string(varchar255) true “Delete” is required in request parameter to Delete Projects Clients
params query string(varchar255) true JSON Object of parameters containing FieldId returned in list API.

Detailed descriptions

params: JSON Object of parameters containing FieldId returned in list API. Example:params={“FieldId”:“WyI2OTQiLCJDdG1IcUoiXQ==”}

Example responses

Success Response

"string"

Responses

Status Meaning Description Schema
Success Unknown Message -> Record Deleted Successfully… string
Fail Unknown Message -> Something went wrong, Please contact your administrator… string

Recruitment

JobPostsList

Code samples

# You can also use wget
curl -X GET https://api1.webhr.co/v3/?module=Recruitment&submodule=JobPosts?request= \
  -H 'Accept: application/json'
GET https://api1.webhr.co/v3/?module=Recruitment&submodule=JobPosts?request= HTTP/1.1
Host: api1.webhr.co
Accept: application/json

const headers = {
  'Accept':'application/json'
};

fetch('https://api1.webhr.co/v3/?module=Recruitment&submodule=JobPosts?request=',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'https://api1.webhr.co/v3/?module=Recruitment&submodule=JobPosts',
  params: {
  'request' => 'string(varchar255)'
}, headers: headers

p JSON.parse(result)
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('https://api1.webhr.co/v3/?module=Recruitment&submodule=JobPosts', params={
  'request': ''
}, headers = headers)

print(r.json())
<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api1.webhr.co/v3/?module=Recruitment&submodule=JobPosts', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...
URL obj = new URL("https://api1.webhr.co/v3/?module=Recruitment&submodule=JobPosts?request=");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api1.webhr.co/v3/?module=Recruitment&submodule=JobPosts", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET ?module=Recruitment&submodule=JobPosts

Lists all Job Posts in your WebHR account

Parameters

Name In Type Required Description
request query string(varchar255) true “List” is required in request parameter to fetch data from WebHR
params query JobPostParams false JSON Array of parameters to get filtered data

Detailed descriptions

params: JSON Array of parameters to get filtered data Example:params={“JobPostStatus”:“Open/Closed”}

Example responses

200 Response

{
  "Status": 1,
  "Summary": {
    "Page": 1,
    "RecordsPerPage": 10,
    "TotalRecords": 0,
    "Offset": 0,
    "NumberOfPages": 0,
    "Search": "string",
    "NextPageURL": "string"
  },
  "Data": [
    {
      "FieldId": "string",
      "DataFields": {
        "JobTitle": "string",
        "ReferenceNumber": null,
        "JobType": "string",
        "NumberOfPositions": 0,
        "CandidateAgeRangeStart": 0,
        "CandidateAgeRangeEnd": 0,
        "CandidateExperience": "string",
        "CandidateQualification": "string",
        "Description": "string",
        "SalaryStartRange": "string",
        "SalaryEndRange": "string",
        "JobPostCompany": "string",
        "JobPostDepartment": "string",
        "JobPostStation": "string"
      }
    }
  ]
}

Responses

Status Meaning Description Schema
200 OK OK JobPosts

JobRequestsList

Code samples

# You can also use wget
curl -X GET https://api1.webhr.co/v3/?module=Recruitment&submodule=JobRequests?request= \
  -H 'Accept: application/json'
GET https://api1.webhr.co/v3/?module=Recruitment&submodule=JobRequests?request= HTTP/1.1
Host: api1.webhr.co
Accept: application/json

const headers = {
  'Accept':'application/json'
};

fetch('https://api1.webhr.co/v3/?module=Recruitment&submodule=JobRequests?request=',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'https://api1.webhr.co/v3/?module=Recruitment&submodule=JobRequests',
  params: {
  'request' => 'string(varchar255)'
}, headers: headers

p JSON.parse(result)
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('https://api1.webhr.co/v3/?module=Recruitment&submodule=JobRequests', params={
  'request': ''
}, headers = headers)

print(r.json())
<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api1.webhr.co/v3/?module=Recruitment&submodule=JobRequests', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...
URL obj = new URL("https://api1.webhr.co/v3/?module=Recruitment&submodule=JobRequests?request=");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api1.webhr.co/v3/?module=Recruitment&submodule=JobRequests", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET ?module=Recruitment&submodule=JobRequests

Lists all Job Requests in your WebHR account

Parameters

Name In Type Required Description
request query string(varchar255) true “List” is required in request parameter to fetch data from WebHR

Example responses

200 Response

{
  "Status": 1,
  "Summary": {
    "Page": 1,
    "RecordsPerPage": 10,
    "TotalRecords": 0,
    "Offset": 0,
    "NumberOfPages": 0,
    "Search": "string",
    "NextPageURL": "string"
  },
  "Data": [
    {
      "FieldId": "string",
      "DataFields": {
        "JobTitle": "string",
        "ReferenceNumber": 0,
        "JobType": "string",
        "NumberOfPositions": 0,
        "CandidateAgeRangeStart": 0,
        "CandidateAgeRangeEnd": 0,
        "CandidateExperience": "string",
        "CandidateQualification": "string",
        "Description": "string",
        "SalaryStartRange": "string",
        "SalaryEndRange": "string"
      }
    }
  ]
}

Responses

Status Meaning Description Schema
200 OK OK JobRequests

CandidatesList

Code samples

# You can also use wget
curl -X GET https://api1.webhr.co/v3/?module=Recruitment&submodule=JobCandidates?request= \
  -H 'Accept: application/json'
GET https://api1.webhr.co/v3/?module=Recruitment&submodule=JobCandidates?request= HTTP/1.1
Host: api1.webhr.co
Accept: application/json

const headers = {
  'Accept':'application/json'
};

fetch('https://api1.webhr.co/v3/?module=Recruitment&submodule=JobCandidates?request=',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'https://api1.webhr.co/v3/?module=Recruitment&submodule=JobCandidates',
  params: {
  'request' => 'string(varchar255)'
}, headers: headers

p JSON.parse(result)
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('https://api1.webhr.co/v3/?module=Recruitment&submodule=JobCandidates', params={
  'request': ''
}, headers = headers)

print(r.json())
<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api1.webhr.co/v3/?module=Recruitment&submodule=JobCandidates', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...
URL obj = new URL("https://api1.webhr.co/v3/?module=Recruitment&submodule=JobCandidates?request=");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api1.webhr.co/v3/?module=Recruitment&submodule=JobCandidates", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET ?module=Recruitment&submodule=JobCandidates

Lists all Candidates in your WebHR account

Parameters

Name In Type Required Description
request query string(varchar255) true “List” is required in request parameter to fetch data from WebHR
params query JobCandidatesParams false JSON Array of parameters to get filtered data

Detailed descriptions

params: JSON Array of parameters to get filtered data Example:params={“AppliedOn_StartDate”:“2021-04-01”,“AppliedOn_EndDate”:“2021-06-02”, “AllowCustomFields”:1} Candidates records returned in the list have applied from jobs portal.

Example responses

200 Response

{
  "Status": 1,
  "Summary": {
    "Page": 1,
    "RecordsPerPage": 10,
    "TotalRecords": 0,
    "Offset": 0,
    "NumberOfPages": 0,
    "Search": "string",
    "NextPageURL": "string"
  },
  "Data": [
    {
      "FieldId": "string",
      "DataFields": {
        "FirstName": "string",
        "LastName": 0,
        "DateOfBirth": "string",
        "Gender": 0,
        "Nationality": 0,
        "Address": 0,
        "City": "string",
        "EmailAddress": "string",
        "PhoneNumber": "string",
        "MobileNumber": "string",
        "JobField": "string",
        "AppliedOn": null,
        "Qualifications": null,
        "Experience": null,
        "Membership": null,
        "Trainings": null,
        "Languages": null,
        "Skills": null,
        "References": null,
        "CustomFields": null
      }
    }
  ]
}

Responses

Status Meaning Description Schema
200 OK OK JobCandidatesList

AddCandidate

Code samples

# You can also use wget
curl -X POST https://api1.webhr.co/v3/?module=Recruitment&submodule=JobCandidates?request=&data=JobField,string,FirstName,string,LastName,string,DateOfBirth,string,Gender,string,Address,string,City,string,ZipCode,string,Country,string,EmailAddress,string,PhoneNumber,string,ResourceSource,string,ResourceSourceDetails,string \
  -H 'Accept: application/json'
POST https://api1.webhr.co/v3/?module=Recruitment&submodule=JobCandidates?request=&data=JobField,string,FirstName,string,LastName,string,DateOfBirth,string,Gender,string,Address,string,City,string,ZipCode,string,Country,string,EmailAddress,string,PhoneNumber,string,ResourceSource,string,ResourceSourceDetails,string HTTP/1.1
Host: api1.webhr.co
Accept: application/json

const headers = {
  'Accept':'application/json'
};

fetch('https://api1.webhr.co/v3/?module=Recruitment&submodule=JobCandidates?request=&data=JobField,string,FirstName,string,LastName,string,DateOfBirth,string,Gender,string,Address,string,City,string,ZipCode,string,Country,string,EmailAddress,string,PhoneNumber,string,ResourceSource,string,ResourceSourceDetails,string',
{
  method: 'POST',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.post 'https://api1.webhr.co/v3/?module=Recruitment&submodule=JobCandidates',
  params: {
  'request' => 'string(varchar255)',
'data' => '[AddCandidate](#schemaaddcandidate)'
}, headers: headers

p JSON.parse(result)
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.post('https://api1.webhr.co/v3/?module=Recruitment&submodule=JobCandidates', params={
  'request': '',  'data': {
  "JobField": "string",
  "FirstName": "string",
  "LastName": "string",
  "DateOfBirth": "string",
  "Gender": "string",
  "Address": "string",
  "City": "string",
  "ZipCode": "string",
  "Country": "string",
  "EmailAddress": "string",
  "PhoneNumber": "string",
  "Interests": null,
  "Achievements": null,
  "ResourceSource": "string",
  "ResourceSourceDetails": "string"
}
}, headers = headers)

print(r.json())
<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','https://api1.webhr.co/v3/?module=Recruitment&submodule=JobCandidates', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...
URL obj = new URL("https://api1.webhr.co/v3/?module=Recruitment&submodule=JobCandidates?request=&data=JobField,string,FirstName,string,LastName,string,DateOfBirth,string,Gender,string,Address,string,City,string,ZipCode,string,Country,string,EmailAddress,string,PhoneNumber,string,ResourceSource,string,ResourceSourceDetails,string");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://api1.webhr.co/v3/?module=Recruitment&submodule=JobCandidates", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST ?module=Recruitment&submodule=JobCandidates

Add Candidates in your WebHR account

Parameters

Name In Type Required Description
request query string(varchar255) true “Add” is required in request to add employees
data query AddCandidate true JSON Array

Detailed descriptions

request: “Add” is required in request to add employees “Add” is required in request parameter to add employees

data: JSON Array “JSON Array” of candidates

Example responses

Success Response

"string"

Responses

Status Meaning Description Schema
Success Unknown Message -> Candidate has been addedd Successfully… string
Fail Unknown Message -> Something went wrong, Please contact your administrator… string

ScreeningInterviewsList

Code samples

# You can also use wget
curl -X GET https://api1.webhr.co/v3/?module=Recruitment&submodule=Screening_Interviews?request= \
  -H 'Accept: application/json'
GET https://api1.webhr.co/v3/?module=Recruitment&submodule=Screening_Interviews?request= HTTP/1.1
Host: api1.webhr.co
Accept: application/json

const headers = {
  'Accept':'application/json'
};

fetch('https://api1.webhr.co/v3/?module=Recruitment&submodule=Screening_Interviews?request=',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'https://api1.webhr.co/v3/?module=Recruitment&submodule=Screening_Interviews',
  params: {
  'request' => 'string(varchar255)'
}, headers: headers

p JSON.parse(result)
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('https://api1.webhr.co/v3/?module=Recruitment&submodule=Screening_Interviews', params={
  'request': ''
}, headers = headers)

print(r.json())
<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api1.webhr.co/v3/?module=Recruitment&submodule=Screening_Interviews', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...
URL obj = new URL("https://api1.webhr.co/v3/?module=Recruitment&submodule=Screening_Interviews?request=");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api1.webhr.co/v3/?module=Recruitment&submodule=Screening_Interviews", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET ?module=Recruitment&submodule=Screening_Interviews

Lists all Screening Interviews in your WebHR account

Parameters

Name In Type Required Description
request query string(varchar255) true “List” is required in request parameter to fetch data from WebHR

Example responses

200 Response

{
  "Status": 1,
  "Summary": {
    "Page": 1,
    "RecordsPerPage": 10,
    "TotalRecords": 0,
    "Offset": 0,
    "NumberOfPages": 0,
    "Search": "string",
    "NextPageURL": "string"
  },
  "Data": [
    {
      "FieldId": "string",
      "DataFields": {
        "InterviewType": "string",
        "InterviewDate": null,
        "InterviewTime": null,
        "PlaceOfInterview": "string",
        "CandidateName": "string",
        "CandidateEmailAddress": "string",
        "CandidateReferenceNumber": 0
      }
    }
  ]
}

Responses

Status Meaning Description Schema
200 OK OK ScreeningInterviews

Payroll

LoansList

Code samples

# You can also use wget
curl -X GET https://api1.webhr.co/v3/?module=Payroll&submodule=Loans?request= \
  -H 'Accept: application/json'
GET https://api1.webhr.co/v3/?module=Payroll&submodule=Loans?request= HTTP/1.1
Host: api1.webhr.co
Accept: application/json

const headers = {
  'Accept':'application/json'
};

fetch('https://api1.webhr.co/v3/?module=Payroll&submodule=Loans?request=',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'https://api1.webhr.co/v3/?module=Payroll&submodule=Loans',
  params: {
  'request' => 'string(varchar255)'
}, headers: headers

p JSON.parse(result)
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('https://api1.webhr.co/v3/?module=Payroll&submodule=Loans', params={
  'request': ''
}, headers = headers)

print(r.json())
<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api1.webhr.co/v3/?module=Payroll&submodule=Loans', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...
URL obj = new URL("https://api1.webhr.co/v3/?module=Payroll&submodule=Loans?request=");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api1.webhr.co/v3/?module=Payroll&submodule=Loans", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET ?module=Payroll&submodule=Loans

Lists all Loans in your WebHR account

Parameters

Name In Type Required Description
request query string(varchar255) true “List” is required in request parameter to fetch data from WebHR

Example responses

200 Response

{
  "Status": 1,
  "Summary": {
    "Page": 1,
    "RecordsPerPage": 10,
    "TotalRecords": 0,
    "Offset": 0,
    "NumberOfPages": 0,
    "Search": "string",
    "NextPageURL": "string"
  },
  "Data": [
    {
      "FieldId": "string",
      "DataFields": {
        "Employee": "string",
        "UserName": "string",
        "Title": "string",
        "LoanAmount": "string",
        "RemainingAmount": "string",
        "MonthlyRepaymentAmount": "string",
        "RepaymentsType": "string",
        "RepaymentsMonths": "string",
        "LoanDate": null,
        "RepaymentStartDate": null,
        "Interest": "string",
        "InterestType": "string",
        "TotalLoanPaid": "string"
      }
    }
  ]
}

Responses

Status Meaning Description Schema
200 OK OK Loans

PayslipsList

Code samples

# You can also use wget
curl -X GET https://api1.webhr.co/v3/?module=Payroll&submodule=Payslips?request=&params=PayslipStartMonth,string,PayslipStartYear,string,PayslipEndMonth,string,PayslipEndYear,string,Company,string,Division,string,Station,string,DepartmentName,string,ShowLeaveSalary,0,ShowEndOfServiceBenefitAllowance,0,ShowLeaveSalaryPaid,0,ShowEndOfServicePaid,0,LeaveType,string \
  -H 'Accept: application/json'
GET https://api1.webhr.co/v3/?module=Payroll&submodule=Payslips?request=&params=PayslipStartMonth,string,PayslipStartYear,string,PayslipEndMonth,string,PayslipEndYear,string,Company,string,Division,string,Station,string,DepartmentName,string,ShowLeaveSalary,0,ShowEndOfServiceBenefitAllowance,0,ShowLeaveSalaryPaid,0,ShowEndOfServicePaid,0,LeaveType,string HTTP/1.1
Host: api1.webhr.co
Accept: application/json

const headers = {
  'Accept':'application/json'
};

fetch('https://api1.webhr.co/v3/?module=Payroll&submodule=Payslips?request=&params=PayslipStartMonth,string,PayslipStartYear,string,PayslipEndMonth,string,PayslipEndYear,string,Company,string,Division,string,Station,string,DepartmentName,string,ShowLeaveSalary,0,ShowEndOfServiceBenefitAllowance,0,ShowLeaveSalaryPaid,0,ShowEndOfServicePaid,0,LeaveType,string',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'https://api1.webhr.co/v3/?module=Payroll&submodule=Payslips',
  params: {
  'request' => 'string(varchar255)',
'params' => '[PayslipParams](#schemapayslipparams)'
}, headers: headers

p JSON.parse(result)
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('https://api1.webhr.co/v3/?module=Payroll&submodule=Payslips', params={
  'request': '',  'params': {
  "PayslipStartMonth": "string",
  "PayslipStartYear": "string",
  "PayslipEndMonth": "string",
  "PayslipEndYear": "string",
  "Company": "string",
  "Division": "string",
  "Station": "string",
  "DepartmentName": "string",
  "ShowLeaveSalary": 0,
  "ShowEndOfServiceBenefitAllowance": 0,
  "ShowLeaveSalaryPaid": 0,
  "ShowEndOfServicePaid": 0,
  "LeaveType": "string"
}
}, headers = headers)

print(r.json())
<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api1.webhr.co/v3/?module=Payroll&submodule=Payslips', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...
URL obj = new URL("https://api1.webhr.co/v3/?module=Payroll&submodule=Payslips?request=&params=PayslipStartMonth,string,PayslipStartYear,string,PayslipEndMonth,string,PayslipEndYear,string,Company,string,Division,string,Station,string,DepartmentName,string,ShowLeaveSalary,0,ShowEndOfServiceBenefitAllowance,0,ShowLeaveSalaryPaid,0,ShowEndOfServicePaid,0,LeaveType,string");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api1.webhr.co/v3/?module=Payroll&submodule=Payslips", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET ?module=Payroll&submodule=Payslips

Lists all Payslips in your WebHR account

Parameters

Name In Type Required Description
request query string(varchar255) true “List” is required in request parameter to fetch data from WebHR
params query PayslipParams true JSON Array of parameters to get filtered data

Detailed descriptions

params: JSON Array of parameters to get filtered data Example:params={“ShowLeaveSalary”:“1”,“ShowEndOfServiceBenefitAllowance”:“1”,“ShowLeaveSalaryPaid”:“0”,“ShowEndOfServicePaid”:“0”,“LeaveType”:“Annual Leaves (Leave Type is mandatory if leaves salary is required.)”}

Example responses

200 Response

{
  "Status": 1,
  "Summary": {
    "Page": 1,
    "RecordsPerPage": 10,
    "TotalRecords": 0,
    "Offset": 0,
    "NumberOfPages": 0,
    "Search": "string",
    "NextPageURL": "string"
  },
  "Data": [
    {
      "FieldId": "string",
      "DataFields": {
        "CompanyName": "string",
        "StationName": "string",
        "DivisionName": "string",
        "UserName": "string",
        "AccessCode": "string",
        "FirstName": "string",
        "LastName": "string",
        "FullName": "string",
        "Nationality": "string",
        "PositionCode": "string",
        "TotalSalary": "string",
        "PayslipItems": null,
        "AdditionalItems": null,
        "SalaryDate": null,
        "SalaryPeriod_StartDate": null,
        "SalaryPeriod_EndDate": null,
        "ApprovalStatus": "string"
      }
    }
  ]
}

Responses

Status Meaning Description Schema
200 OK OK Payslips

SalaryList

Code samples

# You can also use wget
curl -X GET https://api1.webhr.co/v3/?module=Payroll&submodule=Salary?request= \
  -H 'Accept: application/json'
GET https://api1.webhr.co/v3/?module=Payroll&submodule=Salary?request= HTTP/1.1
Host: api1.webhr.co
Accept: application/json

const headers = {
  'Accept':'application/json'
};

fetch('https://api1.webhr.co/v3/?module=Payroll&submodule=Salary?request=',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'https://api1.webhr.co/v3/?module=Payroll&submodule=Salary',
  params: {
  'request' => 'string(varchar255)'
}, headers: headers

p JSON.parse(result)
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('https://api1.webhr.co/v3/?module=Payroll&submodule=Salary', params={
  'request': ''
}, headers = headers)

print(r.json())
<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api1.webhr.co/v3/?module=Payroll&submodule=Salary', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...
URL obj = new URL("https://api1.webhr.co/v3/?module=Payroll&submodule=Salary?request=");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api1.webhr.co/v3/?module=Payroll&submodule=Salary", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET ?module=Payroll&submodule=Salary

Lists all Salaries in your WebHR account

Parameters

Name In Type Required Description
request query string(varchar255) true “List” is required in request parameter to fetch data from WebHR

Example responses

200 Response

{
  "Status": 1,
  "Summary": {
    "Page": 1,
    "RecordsPerPage": 10,
    "TotalRecords": 0,
    "Offset": 0,
    "NumberOfPages": 0,
    "Search": "string",
    "NextPageURL": "string"
  },
  "Data": [
    {
      "FieldId": "string",
      "DataFields": {
        "Employee": "string",
        "UserName": "string",
        "PayrollSetup": "string",
        "SalaryType": "string",
        "Currency": "string",
        "AnnualGrossSalary": null,
        "MonthlyGrossSalary": null,
        "HourlySalary": null,
        "OvertimeHourlySalary": null,
        "HoursPerWeek": null,
        "PayrollItems": null
      }
    }
  ]
}

Responses

Status Meaning Description Schema
200 OK OK Salary

AdvanceSalaryList

Code samples

# You can also use wget
curl -X GET https://api1.webhr.co/v3/?module=Payroll&submodule=AdvanceSalary?request= \
  -H 'Accept: application/json'
GET https://api1.webhr.co/v3/?module=Payroll&submodule=AdvanceSalary?request= HTTP/1.1
Host: api1.webhr.co
Accept: application/json

const headers = {
  'Accept':'application/json'
};

fetch('https://api1.webhr.co/v3/?module=Payroll&submodule=AdvanceSalary?request=',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'https://api1.webhr.co/v3/?module=Payroll&submodule=AdvanceSalary',
  params: {
  'request' => 'string(varchar255)'
}, headers: headers

p JSON.parse(result)
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('https://api1.webhr.co/v3/?module=Payroll&submodule=AdvanceSalary', params={
  'request': ''
}, headers = headers)

print(r.json())
<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api1.webhr.co/v3/?module=Payroll&submodule=AdvanceSalary', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...
URL obj = new URL("https://api1.webhr.co/v3/?module=Payroll&submodule=AdvanceSalary?request=");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api1.webhr.co/v3/?module=Payroll&submodule=AdvanceSalary", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET ?module=Payroll&submodule=AdvanceSalary

Lists all Advance Salaries in your WebHR account

Parameters

Name In Type Required Description
request query string(varchar255) true “List” is required in request parameter to fetch data from WebHR
params query AdvanceSalaryParams false JSON Array of parameters to get filtered data

Example responses

200 Response

{
  "Status": 1,
  "Summary": {
    "Page": 1,
    "RecordsPerPage": 10,
    "TotalRecords": 0,
    "Offset": 0,
    "NumberOfPages": 0,
    "Search": "string",
    "NextPageURL": "string"
  },
  "Data": [
    {
      "FieldId": "string",
      "DataFields": {
        "Employee": "string",
        "UserName": "string",
        "Title": "string",
        "Amount": "string",
        "AdvanceSalaryDate": null
      }
    }
  ]
}

Responses

Status Meaning Description Schema
200 OK OK AdvanceSalary

EarningsList

Code samples

# You can also use wget
curl -X GET https://api1.webhr.co/v3/?module=Payroll&submodule=Earnings?request= \
  -H 'Accept: application/json'
GET https://api1.webhr.co/v3/?module=Payroll&submodule=Earnings?request= HTTP/1.1
Host: api1.webhr.co
Accept: application/json

const headers = {
  'Accept':'application/json'
};

fetch('https://api1.webhr.co/v3/?module=Payroll&submodule=Earnings?request=',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'https://api1.webhr.co/v3/?module=Payroll&submodule=Earnings',
  params: {
  'request' => 'string(varchar255)'
}, headers: headers

p JSON.parse(result)
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('https://api1.webhr.co/v3/?module=Payroll&submodule=Earnings', params={
  'request': ''
}, headers = headers)

print(r.json())
<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api1.webhr.co/v3/?module=Payroll&submodule=Earnings', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...
URL obj = new URL("https://api1.webhr.co/v3/?module=Payroll&submodule=Earnings?request=");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api1.webhr.co/v3/?module=Payroll&submodule=Earnings", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET ?module=Payroll&submodule=Earnings

Lists all Earnings in your WebHR account

Parameters

Name In Type Required Description
request query string(varchar255) true “List” is required in request parameter to fetch data from WebHR

Example responses

200 Response

{
  "Status": 1,
  "Summary": {
    "Page": 1,
    "RecordsPerPage": 10,
    "TotalRecords": 0,
    "Offset": 0,
    "NumberOfPages": 0,
    "Search": "string",
    "NextPageURL": "string"
  },
  "Data": [
    {
      "FieldId": "string",
      "DataFields": {
        "Employee": "string",
        "UserName": "string",
        "Title": "string",
        "Amount": "string",
        "EarningDate": null,
        "EarningType": "string"
      }
    }
  ]
}

Responses

Status Meaning Description Schema
200 OK OK Earnings

BonusesList

Code samples

# You can also use wget
curl -X GET https://api1.webhr.co/v3/?module=Payroll&submodule=Bonuses?request= \
  -H 'Accept: application/json'
GET https://api1.webhr.co/v3/?module=Payroll&submodule=Bonuses?request= HTTP/1.1
Host: api1.webhr.co
Accept: application/json

const headers = {
  'Accept':'application/json'
};

fetch('https://api1.webhr.co/v3/?module=Payroll&submodule=Bonuses?request=',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'https://api1.webhr.co/v3/?module=Payroll&submodule=Bonuses',
  params: {
  'request' => 'string(varchar255)'
}, headers: headers

p JSON.parse(result)
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('https://api1.webhr.co/v3/?module=Payroll&submodule=Bonuses', params={
  'request': ''
}, headers = headers)

print(r.json())
<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api1.webhr.co/v3/?module=Payroll&submodule=Bonuses', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...
URL obj = new URL("https://api1.webhr.co/v3/?module=Payroll&submodule=Bonuses?request=");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api1.webhr.co/v3/?module=Payroll&submodule=Bonuses", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET ?module=Payroll&submodule=Bonuses

Lists all Bonuses in your WebHR account

Parameters

Name In Type Required Description
request query string(varchar255) true “List” is required in request parameter to fetch data from WebHR

Example responses

200 Response

{
  "Status": 1,
  "Summary": {
    "Page": 1,
    "RecordsPerPage": 10,
    "TotalRecords": 0,
    "Offset": 0,
    "NumberOfPages": 0,
    "Search": "string",
    "NextPageURL": "string"
  },
  "Data": [
    {
      "FieldId": "string",
      "DataFields": {
        "Employee": "string",
        "UserName": "string",
        "Title": "string",
        "Amount": "string",
        "BonusDate": null
      }
    }
  ]
}

Responses

Status Meaning Description Schema
200 OK OK Bonuses

CommissionsList

Code samples

# You can also use wget
curl -X GET https://api1.webhr.co/v3/?module=Payroll&submodule=Commissions?request= \
  -H 'Accept: application/json'
GET https://api1.webhr.co/v3/?module=Payroll&submodule=Commissions?request= HTTP/1.1
Host: api1.webhr.co
Accept: application/json

const headers = {
  'Accept':'application/json'
};

fetch('https://api1.webhr.co/v3/?module=Payroll&submodule=Commissions?request=',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'https://api1.webhr.co/v3/?module=Payroll&submodule=Commissions',
  params: {
  'request' => 'string(varchar255)'
}, headers: headers

p JSON.parse(result)
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('https://api1.webhr.co/v3/?module=Payroll&submodule=Commissions', params={
  'request': ''
}, headers = headers)

print(r.json())
<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api1.webhr.co/v3/?module=Payroll&submodule=Commissions', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...
URL obj = new URL("https://api1.webhr.co/v3/?module=Payroll&submodule=Commissions?request=");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api1.webhr.co/v3/?module=Payroll&submodule=Commissions", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET ?module=Payroll&submodule=Commissions

Lists all Commissions in your WebHR account

Parameters

Name In Type Required Description
request query string(varchar255) true “List” is required in request parameter to fetch data from WebHR

Example responses

200 Response

{
  "Status": 1,
  "Summary": {
    "Page": 1,
    "RecordsPerPage": 10,
    "TotalRecords": 0,
    "Offset": 0,
    "NumberOfPages": 0,
    "Search": "string",
    "NextPageURL": "string"
  },
  "Data": [
    {
      "FieldId": "string",
      "DataFields": {
        "Employee": "string",
        "UserName": "string",
        "Title": "string",
        "Amount": "string",
        "CommissionDate": null
      }
    }
  ]
}

Responses

Status Meaning Description Schema
200 OK OK Commissions

DeductionsList

Code samples

# You can also use wget
curl -X GET https://api1.webhr.co/v3/?module=Payroll&submodule=Deductions?request= \
  -H 'Accept: application/json'
GET https://api1.webhr.co/v3/?module=Payroll&submodule=Deductions?request= HTTP/1.1
Host: api1.webhr.co
Accept: application/json

const headers = {
  'Accept':'application/json'
};

fetch('https://api1.webhr.co/v3/?module=Payroll&submodule=Deductions?request=',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'https://api1.webhr.co/v3/?module=Payroll&submodule=Deductions',
  params: {
  'request' => 'string(varchar255)'
}, headers: headers

p JSON.parse(result)
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('https://api1.webhr.co/v3/?module=Payroll&submodule=Deductions', params={
  'request': ''
}, headers = headers)

print(r.json())
<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api1.webhr.co/v3/?module=Payroll&submodule=Deductions', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...
URL obj = new URL("https://api1.webhr.co/v3/?module=Payroll&submodule=Deductions?request=");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api1.webhr.co/v3/?module=Payroll&submodule=Deductions", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET ?module=Payroll&submodule=Deductions

Lists all Deductions in your WebHR account

Parameters

Name In Type Required Description
request query string(varchar255) true “List” is required in request parameter to fetch data from WebHR

Example responses

200 Response

{
  "Status": 1,
  "Summary": {
    "Page": 1,
    "RecordsPerPage": 10,
    "TotalRecords": 0,
    "Offset": 0,
    "NumberOfPages": 0,
    "Search": "string",
    "NextPageURL": "string"
  },
  "Data": [
    {
      "FieldId": "string",
      "DataFields": {
        "Employee": "string",
        "UserName": "string",
        "Title": "string",
        "Amount": "string",
        "DeductionDate": null,
        "DeductionType": "string"
      }
    }
  ]
}

Responses

Status Meaning Description Schema
200 OK OK Deductions

RecurringDeductionsList

Code samples

# You can also use wget
curl -X GET https://api1.webhr.co/v3/?module=Payroll&submodule=RecurringDeductions?request= \
  -H 'Accept: application/json'
GET https://api1.webhr.co/v3/?module=Payroll&submodule=RecurringDeductions?request= HTTP/1.1
Host: api1.webhr.co
Accept: application/json

const headers = {
  'Accept':'application/json'
};

fetch('https://api1.webhr.co/v3/?module=Payroll&submodule=RecurringDeductions?request=',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'https://api1.webhr.co/v3/?module=Payroll&submodule=RecurringDeductions',
  params: {
  'request' => 'string(varchar255)'
}, headers: headers

p JSON.parse(result)
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('https://api1.webhr.co/v3/?module=Payroll&submodule=RecurringDeductions', params={
  'request': ''
}, headers = headers)

print(r.json())
<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api1.webhr.co/v3/?module=Payroll&submodule=RecurringDeductions', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...
URL obj = new URL("https://api1.webhr.co/v3/?module=Payroll&submodule=RecurringDeductions?request=");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api1.webhr.co/v3/?module=Payroll&submodule=RecurringDeductions", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET ?module=Payroll&submodule=RecurringDeductions

Lists all RecurringDeductions in your WebHR account

Parameters

Name In Type Required Description
request query string(varchar255) true “List” is required in request parameter to fetch data from WebHR

Example responses

200 Response

{
  "Status": 1,
  "Summary": {
    "Page": 1,
    "RecordsPerPage": 10,
    "TotalRecords": 0,
    "Offset": 0,
    "NumberOfPages": 0,
    "Search": "string",
    "NextPageURL": "string"
  },
  "Data": [
    {
      "FieldId": "string",
      "DataFields": {
        "Employee": "string",
        "Title": "string",
        "Amount": "string",
        "RecurringDeductionEndDate": null,
        "DeductionType": "string"
      }
    }
  ]
}

Responses

Status Meaning Description Schema
200 OK OK RecurringDeductions

AdjustmentsList

Code samples

# You can also use wget
curl -X GET https://api1.webhr.co/v3/?module=Payroll&submodule=Adjustments?request= \
  -H 'Accept: application/json'
GET https://api1.webhr.co/v3/?module=Payroll&submodule=Adjustments?request= HTTP/1.1
Host: api1.webhr.co
Accept: application/json

const headers = {
  'Accept':'application/json'
};

fetch('https://api1.webhr.co/v3/?module=Payroll&submodule=Adjustments?request=',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'https://api1.webhr.co/v3/?module=Payroll&submodule=Adjustments',
  params: {
  'request' => 'string(varchar255)'
}, headers: headers

p JSON.parse(result)
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('https://api1.webhr.co/v3/?module=Payroll&submodule=Adjustments', params={
  'request': ''
}, headers = headers)

print(r.json())
<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api1.webhr.co/v3/?module=Payroll&submodule=Adjustments', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...
URL obj = new URL("https://api1.webhr.co/v3/?module=Payroll&submodule=Adjustments?request=");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api1.webhr.co/v3/?module=Payroll&submodule=Adjustments", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET ?module=Payroll&submodule=Adjustments

Lists all Adjustments in your WebHR account

Parameters

Name In Type Required Description
request query string(varchar255) true “List” is required in request parameter to fetch data from WebHR

Example responses

200 Response

{
  "Status": 1,
  "Summary": {
    "Page": 1,
    "RecordsPerPage": 10,
    "TotalRecords": 0,
    "Offset": 0,
    "NumberOfPages": 0,
    "Search": "string",
    "NextPageURL": "string"
  },
  "Data": [
    {
      "FieldId": "string",
      "DataFields": {
        "Employee": "string",
        "UserName": "string",
        "Title": "string",
        "Amount": "string",
        "AdjustmentDate": null,
        "AdjustmentType": "string"
      }
    }
  ]
}

Responses

Status Meaning Description Schema
200 OK OK Adjustments

RecurringAdjustmentsList

Code samples

# You can also use wget
curl -X GET https://api1.webhr.co/v3/?module=Payroll&submodule=RecurringAdjustments?request= \
  -H 'Accept: application/json'
GET https://api1.webhr.co/v3/?module=Payroll&submodule=RecurringAdjustments?request= HTTP/1.1
Host: api1.webhr.co
Accept: application/json

const headers = {
  'Accept':'application/json'
};

fetch('https://api1.webhr.co/v3/?module=Payroll&submodule=RecurringAdjustments?request=',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'https://api1.webhr.co/v3/?module=Payroll&submodule=RecurringAdjustments',
  params: {
  'request' => 'string(varchar255)'
}, headers: headers

p JSON.parse(result)
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('https://api1.webhr.co/v3/?module=Payroll&submodule=RecurringAdjustments', params={
  'request': ''
}, headers = headers)

print(r.json())
<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api1.webhr.co/v3/?module=Payroll&submodule=RecurringAdjustments', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...
URL obj = new URL("https://api1.webhr.co/v3/?module=Payroll&submodule=RecurringAdjustments?request=");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api1.webhr.co/v3/?module=Payroll&submodule=RecurringAdjustments", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET ?module=Payroll&submodule=RecurringAdjustments

Lists all Recurring Adjustments in your WebHR account

Parameters

Name In Type Required Description
request query string(varchar255) true “List” is required in request parameter to fetch data from WebHR

Example responses

200 Response

{
  "Status": 1,
  "Summary": {
    "Page": 1,
    "RecordsPerPage": 10,
    "TotalRecords": 0,
    "Offset": 0,
    "NumberOfPages": 0,
    "Search": "string",
    "NextPageURL": "string"
  },
  "Data": [
    {
      "FieldId": "string",
      "DataFields": {
        "Employee": "string",
        "Title": "string",
        "Amount": "string",
        "StartDate": null,
        "EndDate": null,
        "AdjustmentType": "string"
      }
    }
  ]
}

Responses

Status Meaning Description Schema
200 OK OK RecurringAdjustments

HourlyWagesList

Code samples

# You can also use wget
curl -X GET https://api1.webhr.co/v3/?module=Payroll&submodule=HourlyWages?request= \
  -H 'Accept: application/json'
GET https://api1.webhr.co/v3/?module=Payroll&submodule=HourlyWages?request= HTTP/1.1
Host: api1.webhr.co
Accept: application/json

const headers = {
  'Accept':'application/json'
};

fetch('https://api1.webhr.co/v3/?module=Payroll&submodule=HourlyWages?request=',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'https://api1.webhr.co/v3/?module=Payroll&submodule=HourlyWages',
  params: {
  'request' => 'string(varchar255)'
}, headers: headers

p JSON.parse(result)
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('https://api1.webhr.co/v3/?module=Payroll&submodule=HourlyWages', params={
  'request': ''
}, headers = headers)

print(r.json())
<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api1.webhr.co/v3/?module=Payroll&submodule=HourlyWages', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...
URL obj = new URL("https://api1.webhr.co/v3/?module=Payroll&submodule=HourlyWages?request=");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api1.webhr.co/v3/?module=Payroll&submodule=HourlyWages", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET ?module=Payroll&submodule=HourlyWages

Lists all Hourly Wages in your WebHR account

Parameters

Name In Type Required Description
request query string(varchar255) true “List” is required in request parameter to fetch data from WebHR

Example responses

200 Response

{
  "Status": 1,
  "Summary": {
    "Page": 1,
    "RecordsPerPage": 10,
    "TotalRecords": 0,
    "Offset": 0,
    "NumberOfPages": 0,
    "Search": "string",
    "NextPageURL": "string"
  },
  "Data": [
    {
      "FieldId": "string",
      "DataFields": {
        "Employee": "string",
        "UserName": "string",
        "Title": "string",
        "HourlyWageDate": null,
        "RegularHours": "string",
        "OvertimeHours": "string"
      }
    }
  ]
}

Responses

Status Meaning Description Schema
200 OK OK HourlyWages

InsuranceList

Code samples

# You can also use wget
curl -X GET https://api1.webhr.co/v3/?module=Payroll&submodule=Insurance?request= \
  -H 'Accept: application/json'
GET https://api1.webhr.co/v3/?module=Payroll&submodule=Insurance?request= HTTP/1.1
Host: api1.webhr.co
Accept: application/json

const headers = {
  'Accept':'application/json'
};

fetch('https://api1.webhr.co/v3/?module=Payroll&submodule=Insurance?request=',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'https://api1.webhr.co/v3/?module=Payroll&submodule=Insurance',
  params: {
  'request' => 'string(varchar255)'
}, headers: headers

p JSON.parse(result)
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('https://api1.webhr.co/v3/?module=Payroll&submodule=Insurance', params={
  'request': ''
}, headers = headers)

print(r.json())
<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api1.webhr.co/v3/?module=Payroll&submodule=Insurance', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...
URL obj = new URL("https://api1.webhr.co/v3/?module=Payroll&submodule=Insurance?request=");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api1.webhr.co/v3/?module=Payroll&submodule=Insurance", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET ?module=Payroll&submodule=Insurance

Lists all Insurances in your WebHR account

Parameters

Name In Type Required Description
request query string(varchar255) true “List” is required in request parameter to fetch data from WebHR

Example responses

200 Response

{
  "Status": 1,
  "Summary": {
    "Page": 1,
    "RecordsPerPage": 10,
    "TotalRecords": 0,
    "Offset": 0,
    "NumberOfPages": 0,
    "Search": "string",
    "NextPageURL": "string"
  },
  "Data": [
    {
      "FieldId": "string",
      "DataFields": {
        "Employee": "string",
        "UserName": "string",
        "Title": "string",
        "InsuranceType": "string",
        "EmployeeShareAmount": null,
        "OrganizationShareAmount": null,
        "ExpiryDate": null
      }
    }
  ]
}

Responses

Status Meaning Description Schema
200 OK OK Insurance

ReimbursementsList

Code samples

# You can also use wget
curl -X GET https://api1.webhr.co/v3/?module=Payroll&submodule=Reimbursements?request= \
  -H 'Accept: application/json'
GET https://api1.webhr.co/v3/?module=Payroll&submodule=Reimbursements?request= HTTP/1.1
Host: api1.webhr.co
Accept: application/json

const headers = {
  'Accept':'application/json'
};

fetch('https://api1.webhr.co/v3/?module=Payroll&submodule=Reimbursements?request=',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'https://api1.webhr.co/v3/?module=Payroll&submodule=Reimbursements',
  params: {
  'request' => 'string(varchar255)'
}, headers: headers

p JSON.parse(result)
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('https://api1.webhr.co/v3/?module=Payroll&submodule=Reimbursements', params={
  'request': ''
}, headers = headers)

print(r.json())
<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api1.webhr.co/v3/?module=Payroll&submodule=Reimbursements', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...
URL obj = new URL("https://api1.webhr.co/v3/?module=Payroll&submodule=Reimbursements?request=");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api1.webhr.co/v3/?module=Payroll&submodule=Reimbursements", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET ?module=Payroll&submodule=Reimbursements

Lists all Reimbursements in your WebHR account

Parameters

Name In Type Required Description
request query string(varchar255) true “List” is required in request parameter to fetch data from WebHR
params query ReimbursementsParams false JSON Array of parameters to get filtered data

Example responses

200 Response

{
  "Status": 1,
  "Summary": {
    "Page": 1,
    "RecordsPerPage": 10,
    "TotalRecords": 0,
    "Offset": 0,
    "NumberOfPages": 0,
    "Search": "string",
    "NextPageURL": "string"
  },
  "Data": [
    {
      "FieldId": "string",
      "DataFields": {
        "Employee": "string",
        "UserName": "string",
        "Title": "string",
        "ReimbursementDate": null,
        "ApprovalStatus": "string",
        "ReimbursementItems": null
      }
    }
  ]
}

Responses

Status Meaning Description Schema
200 OK OK Reimbursements

CostToCompanyList

Code samples

# You can also use wget
curl -X GET https://api1.webhr.co/v3/?module=Payroll&submodule=CostToCompany?request= \
  -H 'Accept: application/json'
GET https://api1.webhr.co/v3/?module=Payroll&submodule=CostToCompany?request= HTTP/1.1
Host: api1.webhr.co
Accept: application/json

const headers = {
  'Accept':'application/json'
};

fetch('https://api1.webhr.co/v3/?module=Payroll&submodule=CostToCompany?request=',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'https://api1.webhr.co/v3/?module=Payroll&submodule=CostToCompany',
  params: {
  'request' => 'string(varchar255)'
}, headers: headers

p JSON.parse(result)
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('https://api1.webhr.co/v3/?module=Payroll&submodule=CostToCompany', params={
  'request': ''
}, headers = headers)

print(r.json())
<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api1.webhr.co/v3/?module=Payroll&submodule=CostToCompany', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...
URL obj = new URL("https://api1.webhr.co/v3/?module=Payroll&submodule=CostToCompany?request=");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api1.webhr.co/v3/?module=Payroll&submodule=CostToCompany", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET ?module=Payroll&submodule=CostToCompany

Lists all Cost To Company in your WebHR account

Parameters

Name In Type Required Description
request query string(varchar255) true “List” is required in request parameter to fetch data from WebHR

Example responses

200 Response

{
  "Status": 1,
  "Summary": {
    "Page": 1,
    "RecordsPerPage": 10,
    "TotalRecords": 0,
    "Offset": 0,
    "NumberOfPages": 0,
    "Search": "string",
    "NextPageURL": "string"
  },
  "Data": [
    {
      "FieldId": "string",
      "DataFields": {
        "Employee": "string",
        "UserName": "string",
        "Title": "string",
        "CostToCompanyDate": null,
        "CostToCompanyItems": null
      }
    }
  ]
}

Responses

Status Meaning Description Schema
200 OK OK CostToCompany

OvertimesList

Code samples

# You can also use wget
curl -X GET https://api1.webhr.co/v3/?module=Payroll&submodule=Overtimes?request= \
  -H 'Accept: application/json'
GET https://api1.webhr.co/v3/?module=Payroll&submodule=Overtimes?request= HTTP/1.1
Host: api1.webhr.co
Accept: application/json

const headers = {
  'Accept':'application/json'
};

fetch('https://api1.webhr.co/v3/?module=Payroll&submodule=Overtimes?request=',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'https://api1.webhr.co/v3/?module=Payroll&submodule=Overtimes',
  params: {
  'request' => 'string(varchar255)'
}, headers: headers

p JSON.parse(result)
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('https://api1.webhr.co/v3/?module=Payroll&submodule=Overtimes', params={
  'request': ''
}, headers = headers)

print(r.json())
<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api1.webhr.co/v3/?module=Payroll&submodule=Overtimes', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...
URL obj = new URL("https://api1.webhr.co/v3/?module=Payroll&submodule=Overtimes?request=");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api1.webhr.co/v3/?module=Payroll&submodule=Overtimes", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET ?module=Payroll&submodule=Overtimes

Lists all Overtimes in your WebHR account

Parameters

Name In Type Required Description
request query string(varchar255) true “List” is required in request parameter to fetch data from WebHR

Example responses

200 Response

{
  "Status": 1,
  "Summary": {
    "Page": 1,
    "RecordsPerPage": 10,
    "TotalRecords": 0,
    "Offset": 0,
    "NumberOfPages": 0,
    "Search": "string",
    "NextPageURL": "string"
  },
  "Data": [
    {
      "FieldId": "string",
      "DataFields": {
        "Employee": "string",
        "UserName": "string",
        "Title": "string",
        "Amount": "string",
        "OvertimeDate": null,
        "OvertimeTimeIn": null,
        "OvertimeTimeOut": null
      }
    }
  ]
}

Responses

Status Meaning Description Schema
200 OK OK Overtimes

ProvidentFundList

Code samples

# You can also use wget
curl -X GET https://api1.webhr.co/v3/?module=Payroll&submodule=ProvidentFund?request= \
  -H 'Accept: application/json'
GET https://api1.webhr.co/v3/?module=Payroll&submodule=ProvidentFund?request= HTTP/1.1
Host: api1.webhr.co
Accept: application/json

const headers = {
  'Accept':'application/json'
};

fetch('https://api1.webhr.co/v3/?module=Payroll&submodule=ProvidentFund?request=',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'https://api1.webhr.co/v3/?module=Payroll&submodule=ProvidentFund',
  params: {
  'request' => 'string(varchar255)'
}, headers: headers

p JSON.parse(result)
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('https://api1.webhr.co/v3/?module=Payroll&submodule=ProvidentFund', params={
  'request': ''
}, headers = headers)

print(r.json())
<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api1.webhr.co/v3/?module=Payroll&submodule=ProvidentFund', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...
URL obj = new URL("https://api1.webhr.co/v3/?module=Payroll&submodule=ProvidentFund?request=");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api1.webhr.co/v3/?module=Payroll&submodule=ProvidentFund", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET ?module=Payroll&submodule=ProvidentFund

Lists all Provident Funds in your WebHR account

Parameters

Name In Type Required Description
request query string(varchar255) true “List” is required in request parameter to fetch data from WebHR

Example responses

200 Response

{
  "Status": 1,
  "Summary": {
    "Page": 1,
    "RecordsPerPage": 10,
    "TotalRecords": 0,
    "Offset": 0,
    "NumberOfPages": 0,
    "Search": "string",
    "NextPageURL": "string"
  },
  "Data": [
    {
      "FieldId": "string",
      "DataFields": {
        "Employee": "string",
        "UserName": "string",
        "ProvidentFundType": "string",
        "ProvidentFundMethod": "string",
        "EmployeeShare": "string",
        "OrganizationShare": "string"
      }
    }
  ]
}

Responses

Status Meaning Description Schema
200 OK OK ProvidentFund

FinalSettlementsList

Code samples

# You can also use wget
curl -X GET https://api1.webhr.co/v3/?module=Payroll&submodule=FinalSettlements?request= \
  -H 'Accept: application/json'
GET https://api1.webhr.co/v3/?module=Payroll&submodule=FinalSettlements?request= HTTP/1.1
Host: api1.webhr.co
Accept: application/json

const headers = {
  'Accept':'application/json'
};

fetch('https://api1.webhr.co/v3/?module=Payroll&submodule=FinalSettlements?request=',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'https://api1.webhr.co/v3/?module=Payroll&submodule=FinalSettlements',
  params: {
  'request' => 'string(varchar255)'
}, headers: headers

p JSON.parse(result)
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('https://api1.webhr.co/v3/?module=Payroll&submodule=FinalSettlements', params={
  'request': ''
}, headers = headers)

print(r.json())
<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api1.webhr.co/v3/?module=Payroll&submodule=FinalSettlements', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...
URL obj = new URL("https://api1.webhr.co/v3/?module=Payroll&submodule=FinalSettlements?request=");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api1.webhr.co/v3/?module=Payroll&submodule=FinalSettlements", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET ?module=Payroll&submodule=FinalSettlements

Lists all Final Settlements in your WebHR account

Parameters

Name In Type Required Description
request query string(varchar255) true “List” is required in request parameter to fetch data from WebHR

Example responses

200 Response

{
  "Status": 1,
  "Summary": {
    "Page": 1,
    "RecordsPerPage": 10,
    "TotalRecords": 0,
    "Offset": 0,
    "NumberOfPages": 0,
    "Search": "string",
    "NextPageURL": "string"
  },
  "Data": [
    {
      "FieldId": "string",
      "DataFields": {
        "Employee": "string",
        "UserName": "string",
        "Title": "string",
        "FinalSettlementsDate": "string",
        "FinalSettlementsItems": null
      }
    }
  ]
}

Responses

Status Meaning Description Schema
200 OK OK FinalSettlements

HRBudget

OpenPositionsList

Code samples

# You can also use wget
curl -X GET https://api1.webhr.co/v3/?module=HRBudget&submodule=OpenPositions?request= \
  -H 'Accept: application/json'
GET https://api1.webhr.co/v3/?module=HRBudget&submodule=OpenPositions?request= HTTP/1.1
Host: api1.webhr.co
Accept: application/json

const headers = {
  'Accept':'application/json'
};

fetch('https://api1.webhr.co/v3/?module=HRBudget&submodule=OpenPositions?request=',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'https://api1.webhr.co/v3/?module=HRBudget&submodule=OpenPositions',
  params: {
  'request' => 'string(varchar255)'
}, headers: headers

p JSON.parse(result)
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('https://api1.webhr.co/v3/?module=HRBudget&submodule=OpenPositions', params={
  'request': ''
}, headers = headers)

print(r.json())
<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api1.webhr.co/v3/?module=HRBudget&submodule=OpenPositions', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...
URL obj = new URL("https://api1.webhr.co/v3/?module=HRBudget&submodule=OpenPositions?request=");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api1.webhr.co/v3/?module=HRBudget&submodule=OpenPositions", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET ?module=HRBudget&submodule=OpenPositions

Lists all OpenPositions in your WebHR account

Parameters

Name In Type Required Description
request query string(varchar255) true “List” is required in request parameter to fetch data from WebHR

Example responses

200 Response

{
  "Status": 1,
  "Summary": {
    "Page": 1,
    "RecordsPerPage": 10,
    "TotalRecords": 0,
    "Offset": 0,
    "NumberOfPages": 0,
    "Search": "string",
    "NextPageURL": "string"
  },
  "Data": [
    {
      "FieldId": "string",
      "DataFields": {
        "OpenPositionCode": 0,
        "OpenPositionTitle": "string",
        "Status": "string",
        "EstimatedSalary": "string",
        "CompanyName": "string",
        "DivisionName": "string",
        "StationName": "string",
        "DepartmentName": "string"
      }
    }
  ]
}

Responses

Status Meaning Description Schema
200 OK OK OpenPositions

Forms

EmployeesFormsList

Code samples

# You can also use wget
curl -X GET https://api1.webhr.co/v3/?module=Forms&submodule=EmployeesForms?request= \
  -H 'Accept: application/json'
GET https://api1.webhr.co/v3/?module=Forms&submodule=EmployeesForms?request= HTTP/1.1
Host: api1.webhr.co
Accept: application/json

const headers = {
  'Accept':'application/json'
};

fetch('https://api1.webhr.co/v3/?module=Forms&submodule=EmployeesForms?request=',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'https://api1.webhr.co/v3/?module=Forms&submodule=EmployeesForms',
  params: {
  'request' => 'string(varchar255)'
}, headers: headers

p JSON.parse(result)
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('https://api1.webhr.co/v3/?module=Forms&submodule=EmployeesForms', params={
  'request': ''
}, headers = headers)

print(r.json())
<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api1.webhr.co/v3/?module=Forms&submodule=EmployeesForms', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...
URL obj = new URL("https://api1.webhr.co/v3/?module=Forms&submodule=EmployeesForms?request=");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api1.webhr.co/v3/?module=Forms&submodule=EmployeesForms", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET ?module=Forms&submodule=EmployeesForms

Lists Employees Forms in your WebHR account

Parameters

Name In Type Required Description
request query string(varchar255) true “List” is required in request parameter to fetch data from WebHR
params query EmployeesFormsParams false JSON Object of parameters to get filtered data

Detailed descriptions

params: JSON Object of parameters to get filtered data Example:params={“UserName”:“test”, “FormType”:“Test Form”}

Example responses

200 Response

{
  "Status": 1,
  "Summary": {
    "Page": 1,
    "RecordsPerPage": 10,
    "TotalRecords": 0,
    "Offset": 0,
    "NumberOfPages": 0,
    "Search": "string",
    "NextPageURL": "string"
  },
  "Data": [
    {
      "FieldId": "string",
      "DataFields": {
        "Employee": "string",
        "FormSubmissionStatus": "string",
        "SubmittedOn": null,
        "Deadline": null,
        "FormTitle": "string",
        "FormData": []
      }
    }
  ]
}

Responses

Status Meaning Description Schema
200 OK OK EmployeesFormsList

EmployeesFormsSubmit

Code samples

# You can also use wget
curl -X POST https://api1.webhr.co/v3/?module=Forms&submodule=EmployeesForms?request=&params=
POST https://api1.webhr.co/v3/?module=Forms&submodule=EmployeesForms?request=&params= HTTP/1.1
Host: api1.webhr.co

fetch('https://api1.webhr.co/v3/?module=Forms&submodule=EmployeesForms?request=&params=',
{
  method: 'POST'

})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
require 'rest-client'
require 'json'

result = RestClient.post 'https://api1.webhr.co/v3/?module=Forms&submodule=EmployeesForms',
  params: {
  'request' => 'string(varchar255)',
'params' => 'string(varchar255)',
'Data' => 'Array'
}

p JSON.parse(result)
import requests

r = requests.post('https://api1.webhr.co/v3/?module=Forms&submodule=EmployeesForms', params={
  'request': '',  'params': '',  'Data': null
})

print(r.json())
<?php

require 'vendor/autoload.php';

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','https://api1.webhr.co/v3/?module=Forms&submodule=EmployeesForms', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...
URL obj = new URL("https://api1.webhr.co/v3/?module=Forms&submodule=EmployeesForms?request=&params=");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main

import (
       "bytes"
       "net/http"
)

func main() {

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://api1.webhr.co/v3/?module=Forms&submodule=EmployeesForms", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST ?module=Forms&submodule=EmployeesForms

Submit Employees Forms in your WebHR account

Parameters

Name In Type Required Description
request query string(varchar255) true “Add” is required in request parameter to insert data to WebHR.
params query string(varchar255) true JSON Object of parameters containing FieldId returned in list API.
Data query Array true JSON Array of Data.

Detailed descriptions

params: JSON Object of parameters containing FieldId returned in list API. Example:params={“FieldId”:“WyI2OTQiLCJDdG1IcUoiXQ==”}

Data: JSON Array of Data. [{“Result”:“1st Field Result”,“FieldId”:“cf_1”}, {“Result”:“1st Field Result”,“FieldId”:“cf_2”}]

Responses

Status Meaning Description Schema
200 OK OK None

FormTypesList

Code samples

# You can also use wget
curl -X GET https://api1.webhr.co/v3/?module=Forms&submodule=FormTypes?request= \
  -H 'Accept: application/json'
GET https://api1.webhr.co/v3/?module=Forms&submodule=FormTypes?request= HTTP/1.1
Host: api1.webhr.co
Accept: application/json

const headers = {
  'Accept':'application/json'
};

fetch('https://api1.webhr.co/v3/?module=Forms&submodule=FormTypes?request=',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'https://api1.webhr.co/v3/?module=Forms&submodule=FormTypes',
  params: {
  'request' => 'string(varchar255)'
}, headers: headers

p JSON.parse(result)
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('https://api1.webhr.co/v3/?module=Forms&submodule=FormTypes', params={
  'request': ''
}, headers = headers)

print(r.json())
<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api1.webhr.co/v3/?module=Forms&submodule=FormTypes', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...
URL obj = new URL("https://api1.webhr.co/v3/?module=Forms&submodule=FormTypes?request=");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api1.webhr.co/v3/?module=Forms&submodule=FormTypes", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET ?module=Forms&submodule=FormTypes

Lists Employees Form Types in your WebHR account

Parameters

Name In Type Required Description
request query string(varchar255) true “List” is required in request parameter to fetch data from WebHR
params query EmployeesFormTypesParams false JSON Object of parameters to get filtered data

Detailed descriptions

params: JSON Object of parameters to get filtered data Example:params={“FormType”:“Test Form”}

Example responses

200 Response

{
  "Status": 1,
  "Summary": {
    "Page": 1,
    "RecordsPerPage": 10,
    "TotalRecords": 0,
    "Offset": 0,
    "NumberOfPages": 0,
    "Search": "string",
    "NextPageURL": "string"
  },
  "Data": [
    {
      "FieldId": "string",
      "DataFields": {
        "FormTitle": "string",
        "AllowSelfFill": 0,
        "FormData": []
      }
    }
  ]
}

Responses

Status Meaning Description Schema
200 OK OK EmployeesFormTypesList

EmployeesSelfFormsSubmit

Code samples

# You can also use wget
curl -X POST https://api1.webhr.co/v3/?module=Forms&submodule=EmployeesForms&request=SelfFormSubmit?request=&params=
POST https://api1.webhr.co/v3/?module=Forms&submodule=EmployeesForms&request=SelfFormSubmit?request=&params= HTTP/1.1
Host: api1.webhr.co

fetch('https://api1.webhr.co/v3/?module=Forms&submodule=EmployeesForms&request=SelfFormSubmit?request=&params=',
{
  method: 'POST'

})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
require 'rest-client'
require 'json'

result = RestClient.post 'https://api1.webhr.co/v3/?module=Forms&submodule=EmployeesForms&request=SelfFormSubmit',
  params: {
  'request' => 'string(varchar255)',
'params' => 'string(varchar255)',
'Data' => 'Array'
}

p JSON.parse(result)
import requests

r = requests.post('https://api1.webhr.co/v3/?module=Forms&submodule=EmployeesForms&request=SelfFormSubmit', params={
  'request': '',  'params': '',  'Data': null
})

print(r.json())
<?php

require 'vendor/autoload.php';

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','https://api1.webhr.co/v3/?module=Forms&submodule=EmployeesForms&request=SelfFormSubmit', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...
URL obj = new URL("https://api1.webhr.co/v3/?module=Forms&submodule=EmployeesForms&request=SelfFormSubmit?request=&params=");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main

import (
       "bytes"
       "net/http"
)

func main() {

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://api1.webhr.co/v3/?module=Forms&submodule=EmployeesForms&request=SelfFormSubmit", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST ?module=Forms&submodule=EmployeesForms&request=SelfFormSubmit

Submit Employees Forms in your WebHR account

Parameters

Name In Type Required Description
request query string(varchar255) true “SelfFormSubmit” is required in request parameter to insert data to WebHR.
params query string(varchar255) true JSON Object of parameters containing FieldId returned in Form Types list API.
Data query Array true JSON Array of Data.

Detailed descriptions

params: JSON Object of parameters containing FieldId returned in Form Types list API. Example:params={“FieldId”:“WyI2OTQiLCJDdG1IcUoiXQ==”, “UserName”:“admin”}

Data: JSON Array of Data. [{“Result”:“1st Field Result”,“FieldId”:“cf_1”}, {“Result”:“1st Field Result”,“FieldId”:“cf_2”}]

Responses

Status Meaning Description Schema
200 OK OK None

JobCandidateFormsList

Code samples

# You can also use wget
curl -X GET https://api1.webhr.co/v3/?module=Forms&submodule=JobCandidateForms?request= \
  -H 'Accept: application/json'
GET https://api1.webhr.co/v3/?module=Forms&submodule=JobCandidateForms?request= HTTP/1.1
Host: api1.webhr.co
Accept: application/json

const headers = {
  'Accept':'application/json'
};

fetch('https://api1.webhr.co/v3/?module=Forms&submodule=JobCandidateForms?request=',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'https://api1.webhr.co/v3/?module=Forms&submodule=JobCandidateForms',
  params: {
  'request' => 'string(varchar255)'
}, headers: headers

p JSON.parse(result)
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('https://api1.webhr.co/v3/?module=Forms&submodule=JobCandidateForms', params={
  'request': ''
}, headers = headers)

print(r.json())
<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api1.webhr.co/v3/?module=Forms&submodule=JobCandidateForms', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...
URL obj = new URL("https://api1.webhr.co/v3/?module=Forms&submodule=JobCandidateForms?request=");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api1.webhr.co/v3/?module=Forms&submodule=JobCandidateForms", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET ?module=Forms&submodule=JobCandidateForms

Lists Job Candidate Forms in your WebHR account

Parameters

Name In Type Required Description
request query string(varchar255) true “List” is required in request parameter to fetch data from WebHR
params query JobCandidateFormsParams false JSON Object of parameters to get filtered data

Detailed descriptions

params: JSON Object of parameters to get filtered data Example:params={“JobCandidateEmailAddress":"[email protected]”}

Example responses

Responses

Status Meaning Description Schema
200 OK OK None

Response Schema

Expense

ExpensesList

Code samples

# You can also use wget
curl -X GET https://api1.webhr.co/v3/?module=Expense&submodule=Expenses?request= \
  -H 'Accept: application/json'
GET https://api1.webhr.co/v3/?module=Expense&submodule=Expenses?request= HTTP/1.1
Host: api1.webhr.co
Accept: application/json

const headers = {
  'Accept':'application/json'
};

fetch('https://api1.webhr.co/v3/?module=Expense&submodule=Expenses?request=',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'https://api1.webhr.co/v3/?module=Expense&submodule=Expenses',
  params: {
  'request' => 'string(varchar255)'
}, headers: headers

p JSON.parse(result)
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('https://api1.webhr.co/v3/?module=Expense&submodule=Expenses', params={
  'request': ''
}, headers = headers)

print(r.json())
<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api1.webhr.co/v3/?module=Expense&submodule=Expenses', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...
URL obj = new URL("https://api1.webhr.co/v3/?module=Expense&submodule=Expenses?request=");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api1.webhr.co/v3/?module=Expense&submodule=Expenses", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET ?module=Expense&submodule=Expenses

Lists all Expenses in your WebHR account

Parameters

Name In Type Required Description
request query string(varchar255) true “List” is required in request parameter to fetch data from WebHR

Example responses

200 Response

{
  "Employee": "string",
  "UserName": "string",
  "Title": "string",
  "ExpenseDate": "string",
  "TotalAmount": "string",
  "ExpenseItems": null
}

Responses

Status Meaning Description Schema
200 OK OK Expenses

Assets

AssetsList

Code samples

# You can also use wget
curl -X GET https://api1.webhr.co/v3/?module=Assets&submodule=Assets?request= \
  -H 'Accept: application/json'
GET https://api1.webhr.co/v3/?module=Assets&submodule=Assets?request= HTTP/1.1
Host: api1.webhr.co
Accept: application/json

const headers = {
  'Accept':'application/json'
};

fetch('https://api1.webhr.co/v3/?module=Assets&submodule=Assets?request=',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'https://api1.webhr.co/v3/?module=Assets&submodule=Assets',
  params: {
  'request' => 'string(varchar255)'
}, headers: headers

p JSON.parse(result)
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('https://api1.webhr.co/v3/?module=Assets&submodule=Assets', params={
  'request': ''
}, headers = headers)

print(r.json())
<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api1.webhr.co/v3/?module=Assets&submodule=Assets', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...
URL obj = new URL("https://api1.webhr.co/v3/?module=Assets&submodule=Assets?request=");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api1.webhr.co/v3/?module=Assets&submodule=Assets", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET ?module=Assets&submodule=Assets

Lists all Assets in your WebHR account

Parameters

Name In Type Required Description
request query string(varchar255) true “List” is required in request parameter to fetch data from WebHR

Example responses

200 Response

{
  "Status": 1,
  "Summary": {
    "Page": 1,
    "RecordsPerPage": 10,
    "TotalRecords": 0,
    "Offset": 0,
    "NumberOfPages": 0,
    "Search": "string",
    "NextPageURL": "string"
  },
  "Data": [
    {
      "FieldId": "string",
      "DataFields": {
        "AssetName": "string",
        "AssetCode": "string",
        "AssetTag": "string",
        "Quantity": "string",
        "AssetCost": "string"
      }
    }
  ]
}

Responses

Status Meaning Description Schema
200 OK OK Assets

CheckOutList

Code samples

# You can also use wget
curl -X GET https://api1.webhr.co/v3/?module=Assets&submodule=CheckOut?request= \
  -H 'Accept: application/json'
GET https://api1.webhr.co/v3/?module=Assets&submodule=CheckOut?request= HTTP/1.1
Host: api1.webhr.co
Accept: application/json

const headers = {
  'Accept':'application/json'
};

fetch('https://api1.webhr.co/v3/?module=Assets&submodule=CheckOut?request=',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'https://api1.webhr.co/v3/?module=Assets&submodule=CheckOut',
  params: {
  'request' => 'string(varchar255)'
}, headers: headers

p JSON.parse(result)
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('https://api1.webhr.co/v3/?module=Assets&submodule=CheckOut', params={
  'request': ''
}, headers = headers)

print(r.json())
<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api1.webhr.co/v3/?module=Assets&submodule=CheckOut', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...
URL obj = new URL("https://api1.webhr.co/v3/?module=Assets&submodule=CheckOut?request=");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api1.webhr.co/v3/?module=Assets&submodule=CheckOut", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET ?module=Assets&submodule=CheckOut

Lists all CheckOuts in your WebHR account

Parameters

Name In Type Required Description
request query string(varchar255) true “List” is required in request parameter to fetch data from WebHR

Example responses

200 Response

{
  "Status": 1,
  "Summary": {
    "Page": 1,
    "RecordsPerPage": 10,
    "TotalRecords": 0,
    "Offset": 0,
    "NumberOfPages": 0,
    "Search": "string",
    "NextPageURL": "string"
  },
  "Data": [
    {
      "FieldId": "string",
      "DataFields": {
        "AssetName": "string",
        "AssetCode": "string",
        "Employee": "string",
        "UserName": "string",
        "ReferenceNumber": 0,
        "CheckoutDateTime": null,
        "CheckinDateTime": null,
        "Status": "string"
      }
    }
  ]
}

Responses

Status Meaning Description Schema
200 OK OK CheckOuts

Trainings

EmployeeTrainings

Code samples

# You can also use wget
curl -X GET https://api1.webhr.co/v3/?module=Trainings&submodule=EmployeeTrainings?request= \
  -H 'Accept: application/json'
GET https://api1.webhr.co/v3/?module=Trainings&submodule=EmployeeTrainings?request= HTTP/1.1
Host: api1.webhr.co
Accept: application/json

const headers = {
  'Accept':'application/json'
};

fetch('https://api1.webhr.co/v3/?module=Trainings&submodule=EmployeeTrainings?request=',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'https://api1.webhr.co/v3/?module=Trainings&submodule=EmployeeTrainings',
  params: {
  'request' => 'string(varchar255)'
}, headers: headers

p JSON.parse(result)
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('https://api1.webhr.co/v3/?module=Trainings&submodule=EmployeeTrainings', params={
  'request': ''
}, headers = headers)

print(r.json())
<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api1.webhr.co/v3/?module=Trainings&submodule=EmployeeTrainings', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...
URL obj = new URL("https://api1.webhr.co/v3/?module=Trainings&submodule=EmployeeTrainings?request=");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api1.webhr.co/v3/?module=Trainings&submodule=EmployeeTrainings", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET ?module=Trainings&submodule=EmployeeTrainings

Lists all Employee Trainings in your WebHR account

Parameters

Name In Type Required Description
request query string(varchar255) true “List” is required in request parameter to fetch data from WebHR

Example responses

200 Response

{
  "Status": 1,
  "Summary": {
    "Page": 1,
    "RecordsPerPage": 10,
    "TotalRecords": 0,
    "Offset": 0,
    "NumberOfPages": 0,
    "Search": "string",
    "NextPageURL": "string"
  },
  "Data": [
    {
      "FieldId": "string",
      "DataFields": {
        "TrainingType": "string",
        "TrainingSubject": "string",
        "TrainingTitle": "string",
        "DateFrom": null,
        "DateTo": null
      }
    }
  ]
}

Responses

Status Meaning Description Schema
200 OK OK EmployeeTrainings

PendingCourses

Code samples

# You can also use wget
curl -X GET https://api1.webhr.co/v3/?module=Trainings&submodule=PendingCourses?request= \
  -H 'Accept: application/json'
GET https://api1.webhr.co/v3/?module=Trainings&submodule=PendingCourses?request= HTTP/1.1
Host: api1.webhr.co
Accept: application/json

const headers = {
  'Accept':'application/json'
};

fetch('https://api1.webhr.co/v3/?module=Trainings&submodule=PendingCourses?request=',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'https://api1.webhr.co/v3/?module=Trainings&submodule=PendingCourses',
  params: {
  'request' => 'string(varchar255)'
}, headers: headers

p JSON.parse(result)
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('https://api1.webhr.co/v3/?module=Trainings&submodule=PendingCourses', params={
  'request': ''
}, headers = headers)

print(r.json())
<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api1.webhr.co/v3/?module=Trainings&submodule=PendingCourses', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...
URL obj = new URL("https://api1.webhr.co/v3/?module=Trainings&submodule=PendingCourses?request=");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api1.webhr.co/v3/?module=Trainings&submodule=PendingCourses", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET ?module=Trainings&submodule=PendingCourses

Lists all Pending Courses in your WebHR account

Parameters

Name In Type Required Description
request query string(varchar255) true “List” is required in request parameter to fetch data from WebHR

Example responses

200 Response

{
  "Status": 1,
  "Summary": {
    "Page": 1,
    "RecordsPerPage": 10,
    "TotalRecords": 0,
    "Offset": 0,
    "NumberOfPages": 0,
    "Search": "string",
    "NextPageURL": "string"
  },
  "Data": [
    {
      "FieldId": "string",
      "DataFields": {
        "CourseName": "string",
        "Employee": "string",
        "CourseDeadline": null,
        "TimeSpent": null,
        "Progress": "string"
      }
    }
  ]
}

Responses

Status Meaning Description Schema
200 OK OK PendingCourses

CompletedCourses

Code samples

# You can also use wget
curl -X GET https://api1.webhr.co/v3/?module=Trainings&submodule=CompletedCourses?request= \
  -H 'Accept: application/json'
GET https://api1.webhr.co/v3/?module=Trainings&submodule=CompletedCourses?request= HTTP/1.1
Host: api1.webhr.co
Accept: application/json

const headers = {
  'Accept':'application/json'
};

fetch('https://api1.webhr.co/v3/?module=Trainings&submodule=CompletedCourses?request=',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'https://api1.webhr.co/v3/?module=Trainings&submodule=CompletedCourses',
  params: {
  'request' => 'string(varchar255)'
}, headers: headers

p JSON.parse(result)
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('https://api1.webhr.co/v3/?module=Trainings&submodule=CompletedCourses', params={
  'request': ''
}, headers = headers)

print(r.json())
<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api1.webhr.co/v3/?module=Trainings&submodule=CompletedCourses', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...
URL obj = new URL("https://api1.webhr.co/v3/?module=Trainings&submodule=CompletedCourses?request=");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api1.webhr.co/v3/?module=Trainings&submodule=CompletedCourses", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET ?module=Trainings&submodule=CompletedCourses

Lists all Completed Courses in your WebHR account

Parameters

Name In Type Required Description
request query string(varchar255) true “List” is required in request parameter to fetch data from WebHR

Example responses

200 Response

{
  "Status": 1,
  "Summary": {
    "Page": 1,
    "RecordsPerPage": 10,
    "TotalRecords": 0,
    "Offset": 0,
    "NumberOfPages": 0,
    "Search": "string",
    "NextPageURL": "string"
  },
  "Data": [
    {
      "FieldId": "string",
      "DataFields": {
        "CourseName": "string",
        "Employee": "string",
        "CompletedOn": null,
        "ExpectedTime": null,
        "TimeSpent": null,
        "TrainingStatus": "string",
        "TestStatus": "string"
      }
    }
  ]
}

Responses

Status Meaning Description Schema
200 OK OK CompletedCourses

Goals

Goals

Code samples

# You can also use wget
curl -X GET https://api1.webhr.co/v3/?module=Goals&submodule=Goals&request=List?request= \
  -H 'Accept: application/json'
GET https://api1.webhr.co/v3/?module=Goals&submodule=Goals&request=List?request= HTTP/1.1
Host: api1.webhr.co
Accept: application/json

const headers = {
  'Accept':'application/json'
};

fetch('https://api1.webhr.co/v3/?module=Goals&submodule=Goals&request=List?request=',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'https://api1.webhr.co/v3/?module=Goals&submodule=Goals&request=List',
  params: {
  'request' => 'string(varchar255)'
}, headers: headers

p JSON.parse(result)
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('https://api1.webhr.co/v3/?module=Goals&submodule=Goals&request=List', params={
  'request': ''
}, headers = headers)

print(r.json())
<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api1.webhr.co/v3/?module=Goals&submodule=Goals&request=List', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...
URL obj = new URL("https://api1.webhr.co/v3/?module=Goals&submodule=Goals&request=List?request=");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api1.webhr.co/v3/?module=Goals&submodule=Goals&request=List", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET ?module=Goals&submodule=Goals&request=List

Lists all Goals in your WebHR account

Parameters

Name In Type Required Description
request query string(varchar255) true “List” is required in request parameter to fetch data from WebHR

Example responses

200 Response

{
  "Status": 1,
  "Summary": {
    "Page": 1,
    "RecordsPerPage": 10,
    "TotalRecords": 0,
    "Offset": 0,
    "NumberOfPages": 0,
    "Search": "string",
    "NextPageURL": "string"
  },
  "Data": [
    {
      "FieldId": "string",
      "DataFields": {
        "UserName": "string",
        "Employee": "string",
        "Title": "string",
        "GoalCategoryName": "string",
        "StartDate": null,
        "EndDate": null,
        "TargetMetric": "string",
        "TargetMetricUnit": "string",
        "Percentage": "string"
      }
    }
  ]
}

Responses

Status Meaning Description Schema
200 OK OK Goals

GoalsAddProgress

Code samples

# You can also use wget
curl -X POST https://api1.webhr.co/v3/?module=Goals&submodule=Goals&request=AddProgress?request=&params=FieldId,string,Data,%5Bobject%20Object%5D \
  -H 'Accept: application/json'
POST https://api1.webhr.co/v3/?module=Goals&submodule=Goals&request=AddProgress?request=&params=FieldId,string,Data,%5Bobject%20Object%5D HTTP/1.1
Host: api1.webhr.co
Accept: application/json

const headers = {
  'Accept':'application/json'
};

fetch('https://api1.webhr.co/v3/?module=Goals&submodule=Goals&request=AddProgress?request=&params=FieldId,string,Data,%5Bobject%20Object%5D',
{
  method: 'POST',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.post 'https://api1.webhr.co/v3/?module=Goals&submodule=Goals&request=AddProgress',
  params: {
  'request' => 'string(varchar255)',
'params' => '[GoalsAddProgress](#schemagoalsaddprogress)'
}, headers: headers

p JSON.parse(result)
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.post('https://api1.webhr.co/v3/?module=Goals&submodule=Goals&request=AddProgress', params={
  'request': '',  'params': {
  "FieldId": "string",
  "Data": {}
}
}, headers = headers)

print(r.json())
<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','https://api1.webhr.co/v3/?module=Goals&submodule=Goals&request=AddProgress', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...
URL obj = new URL("https://api1.webhr.co/v3/?module=Goals&submodule=Goals&request=AddProgress?request=&params=FieldId,string,Data,%5Bobject%20Object%5D");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://api1.webhr.co/v3/?module=Goals&submodule=Goals&request=AddProgress", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST ?module=Goals&submodule=Goals&request=AddProgress

Add Goal Progress in your WebHR account

Parameters

Name In Type Required Description
request query string(varchar255) true “AddProgress” is required in request to add Progress
params query GoalsAddProgress true “JSON Object” of params

Example responses

Success Response

"string"

Responses

Status Meaning Description Schema
Success Unknown Message -> Goal Progress Added Successfully. string
Fail Unknown Message -> Something went wrong, Please contact your administrator… string

Reports

EmployeeLeaveSalaryAndEOSReport

Code samples

# You can also use wget
curl -X GET https://api1.webhr.co/v3/?module=Reports&submodule=Payroll&request=EmployeeLeaveSalaryAndEOSReport?request= \
  -H 'Accept: application/json'
GET https://api1.webhr.co/v3/?module=Reports&submodule=Payroll&request=EmployeeLeaveSalaryAndEOSReport?request= HTTP/1.1
Host: api1.webhr.co
Accept: application/json

const headers = {
  'Accept':'application/json'
};

fetch('https://api1.webhr.co/v3/?module=Reports&submodule=Payroll&request=EmployeeLeaveSalaryAndEOSReport?request=',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'https://api1.webhr.co/v3/?module=Reports&submodule=Payroll&request=EmployeeLeaveSalaryAndEOSReport',
  params: {
  'request' => 'string(varchar255)'
}, headers: headers

p JSON.parse(result)
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('https://api1.webhr.co/v3/?module=Reports&submodule=Payroll&request=EmployeeLeaveSalaryAndEOSReport', params={
  'request': ''
}, headers = headers)

print(r.json())
<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api1.webhr.co/v3/?module=Reports&submodule=Payroll&request=EmployeeLeaveSalaryAndEOSReport', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...
URL obj = new URL("https://api1.webhr.co/v3/?module=Reports&submodule=Payroll&request=EmployeeLeaveSalaryAndEOSReport?request=");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api1.webhr.co/v3/?module=Reports&submodule=Payroll&request=EmployeeLeaveSalaryAndEOSReport", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET ?module=Reports&submodule=Payroll&request=EmployeeLeaveSalaryAndEOSReport

Get reports data in your WebHR account

Parameters

Name In Type Required Description
request query string(varchar255) true “Report Name” is required in request parameter to fetch report data from WebHR
params query EmployeeLeaveSalaryAndEOSReportParams false JSON Array of parameters to get filtered data

Detailed descriptions

params: JSON Array of parameters to get filtered data Example:params={“StartYear”:“2021”, “StartMonth”:“01”, “EndYear”:“2021”, “EndMonth”:“10”}

Example responses

200 Response

{
  "Period": "string",
  "SalaryDate": "string",
  "UserName": "string",
  "Department": "string",
  "Nationality": "string",
  "BasicSalary": "string",
  "Allowances": null,
  "PayrollItems": null,
  "LeavesSalaryAllowance": "string",
  "EndofServiceBenefitsAllowance": "string",
  "LeavesSalaryPaid": "string",
  "EndOfServicePaid": "string",
  "NetTotal": "string",
  "Currency": "string",
  "PhoneAllowance": "string",
  "FuelAllowance": "string"
}

Responses

Status Meaning Description Schema
200 OK OK EmployeeLeaveSalaryAndEOSReport

PayrollExtractionReport

Code samples

# You can also use wget
curl -X GET https://api1.webhr.co/v3/?module=Reports&submodule=Payroll&request=PayrollExtractionReport?request= \
  -H 'Accept: application/json'
GET https://api1.webhr.co/v3/?module=Reports&submodule=Payroll&request=PayrollExtractionReport?request= HTTP/1.1
Host: api1.webhr.co
Accept: application/json

const headers = {
  'Accept':'application/json'
};

fetch('https://api1.webhr.co/v3/?module=Reports&submodule=Payroll&request=PayrollExtractionReport?request=',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'https://api1.webhr.co/v3/?module=Reports&submodule=Payroll&request=PayrollExtractionReport',
  params: {
  'request' => 'string(varchar255)'
}, headers: headers

p JSON.parse(result)
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('https://api1.webhr.co/v3/?module=Reports&submodule=Payroll&request=PayrollExtractionReport', params={
  'request': ''
}, headers = headers)

print(r.json())
<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api1.webhr.co/v3/?module=Reports&submodule=Payroll&request=PayrollExtractionReport', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...
URL obj = new URL("https://api1.webhr.co/v3/?module=Reports&submodule=Payroll&request=PayrollExtractionReport?request=");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api1.webhr.co/v3/?module=Reports&submodule=Payroll&request=PayrollExtractionReport", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET ?module=Reports&submodule=Payroll&request=PayrollExtractionReport

Get reports data in your WebHR account

Parameters

Name In Type Required Description
request query string(varchar255) true “Report Name” is required in request parameter to fetch report data from WebHR
params query PayrollExtractionReportParams false JSON Array of parameters to get filtered data

Detailed descriptions

params: JSON Array of parameters to get filtered data Example:params={“StartYear”:“2021”, “StartMonth”:“01”, “EndYear”:“2021”, “EndMonth”:“10”}

Example responses

200 Response

{
  "Period": "string",
  "SalaryDate": "string",
  "UserName": "string",
  "Department": "string",
  "Nationality": "string",
  "BasicSalary": "string",
  "Allowances": "string",
  "PayrollItems": "string",
  "Commissions": "string",
  "Deductions": "string",
  "AitTicketAllowance": "string",
  "AdjustmentsChildStudy": "string",
  "AdjustmentsActingAllowance": "string",
  "EmployeeContribution": "string",
  "OrganizationContribution": "string",
  "LoanRepayments": "string",
  "NetTotal": "string",
  "PhoneAllowance": "string",
  "FuelAllowance": "string"
}

Responses

Status Meaning Description Schema
200 OK OK PayrollExtractionReport

Schemas

Companies

{
  "Status": 1,
  "Summary": {
    "Page": 1,
    "RecordsPerPage": 10,
    "TotalRecords": 0,
    "Offset": 0,
    "NumberOfPages": 0,
    "Search": "string",
    "NextPageURL": "string"
  },
  "Data": [
    {
      "FieldId": "string",
      "DataFields": {
        "Company": "string",
        "LegalName": "string",
        "ContactNumber": "string",
        "FaxNumber": "string",
        "EmailAddress": "string",
        "Website": "string",
        "BankName": "string",
        "AccountTitle": "string",
        "AccountNumber": "string",
        "RoutingNumber": "string",
        "AccountType": "string"
      }
    }
  ]
}

Companies

Properties

Name Type Required Restrictions Description
Status integer false none 0 -> Fail
1 -> Success
Summary Summary false none JSON Object of Summary
Data [CompaniesData] false none JSON Array of Data Fields

CompaniesData

{
  "FieldId": "string",
  "DataFields": {
    "Company": "string",
    "LegalName": "string",
    "ContactNumber": "string",
    "FaxNumber": "string",
    "EmailAddress": "string",
    "Website": "string",
    "BankName": "string",
    "AccountTitle": "string",
    "AccountNumber": "string",
    "RoutingNumber": "string",
    "AccountType": "string"
  }
}

Companies Data

Properties

Name Type Required Restrictions Description
FieldId string false none none
DataFields CompaniesDataFields false none JSON Object of Data Fields

CompaniesDataFields

{
  "Company": "string",
  "LegalName": "string",
  "ContactNumber": "string",
  "FaxNumber": "string",
  "EmailAddress": "string",
  "Website": "string",
  "BankName": "string",
  "AccountTitle": "string",
  "AccountNumber": "string",
  "RoutingNumber": "string",
  "AccountType": "string"
}

Companies Data Fields

Properties

Name Type Required Restrictions Description
Company string false none none
LegalName string false none none
ContactNumber string false none none
FaxNumber string false none none
EmailAddress string false none none
Website string false none none
BankName string false none none
AccountTitle string false none none
AccountNumber string false none none
RoutingNumber string false none none
AccountType string false none none

Divisions

{
  "Status": 1,
  "Summary": {
    "Page": 1,
    "RecordsPerPage": 10,
    "TotalRecords": 0,
    "Offset": 0,
    "NumberOfPages": 0,
    "Search": "string",
    "NextPageURL": "string"
  },
  "Data": [
    {
      "FieldId": "string",
      "DataFields": {
        "Company": "string",
        "DivisionType": "string",
        "DivisionName": "string",
        "DivisionHead": "string"
      }
    }
  ]
}

Divisions

Properties

Name Type Required Restrictions Description
Status integer false none 0 -> Fail
1 -> Success
Summary Summary false none JSON Object of Summary
Data [DivisionsData] false none JSON Array of Data Fields

DivisionsData

{
  "FieldId": "string",
  "DataFields": {
    "Company": "string",
    "DivisionType": "string",
    "DivisionName": "string",
    "DivisionHead": "string"
  }
}

Divisions Data

Properties

Name Type Required Restrictions Description
FieldId string false none none
DataFields DivisionsDataFields false none JSON Object of Data Fields

DivisionsDataFields

{
  "Company": "string",
  "DivisionType": "string",
  "DivisionName": "string",
  "DivisionHead": "string"
}

Divisions Data Fields

Properties

Name Type Required Restrictions Description
Company string false none none
DivisionType string false none none
DivisionName string false none none
DivisionHead string false none none

Stations

{
  "Status": 1,
  "Summary": {
    "Page": 1,
    "RecordsPerPage": 10,
    "TotalRecords": 0,
    "Offset": 0,
    "NumberOfPages": 0,
    "Search": "string",
    "NextPageURL": "string"
  },
  "Data": [
    {
      "FieldId": "string",
      "DataFields": {
        "StationName": "string",
        "Address": "string",
        "City": "string",
        "State": "string",
        "ZipCode": "string",
        "Country": "string",
        "PhoneNumber": "string",
        "FaxNumber": "string",
        "EmailAddress": "string",
        "Website": "string",
        "Latitude": "string",
        "Longitude": "string",
        "StationHead": "string",
        "StationGeneralManager": "string",
        "StationCurrency": "string"
      }
    }
  ]
}

Stations

Properties

Name Type Required Restrictions Description
Status integer false none 0 -> Fail
1 -> Success
Summary Summary false none JSON Object of Summary
Data [StationsData] false none JSON Array of Data Fields

StationsData

{
  "FieldId": "string",
  "DataFields": {
    "StationName": "string",
    "Address": "string",
    "City": "string",
    "State": "string",
    "ZipCode": "string",
    "Country": "string",
    "PhoneNumber": "string",
    "FaxNumber": "string",
    "EmailAddress": "string",
    "Website": "string",
    "Latitude": "string",
    "Longitude": "string",
    "StationHead": "string",
    "StationGeneralManager": "string",
    "StationCurrency": "string"
  }
}

Stations Data

Properties

Name Type Required Restrictions Description
FieldId string false none none
DataFields StationsDataFields false none JSON Object of Data Fields

StationsDataFields

{
  "StationName": "string",
  "Address": "string",
  "City": "string",
  "State": "string",
  "ZipCode": "string",
  "Country": "string",
  "PhoneNumber": "string",
  "FaxNumber": "string",
  "EmailAddress": "string",
  "Website": "string",
  "Latitude": "string",
  "Longitude": "string",
  "StationHead": "string",
  "StationGeneralManager": "string",
  "StationCurrency": "string"
}

Stations Data Fields

Properties

Name Type Required Restrictions Description
StationName string false none none
Address string false none none
City string false none none
State string false none none
ZipCode string false none none
Country string false none none
PhoneNumber string false none none
FaxNumber string false none none
EmailAddress string false none none
Website string false none none
Latitude string false none none
Longitude string false none none
StationHead string false none none
StationGeneralManager string false none none
StationCurrency string false none none

Departments

{
  "Status": 1,
  "Summary": {
    "Page": 1,
    "RecordsPerPage": 10,
    "TotalRecords": 0,
    "Offset": 0,
    "NumberOfPages": 0,
    "Search": "string",
    "NextPageURL": "string"
  },
  "Data": [
    {
      "FieldId": "string",
      "DataFields": {
        "Company": null,
        "Division": "string",
        "Station": "string",
        "DepartmentName": "string",
        "DepartmentHead": "string",
        "ParentDepartment": "string"
      }
    }
  ]
}

Departments

Properties

Name Type Required Restrictions Description
Status integer false none 0 -> Fail
1 -> Success
Summary Summary false none JSON Object of Summary
Data [DepartmentsData] false none JSON Array of Data Fields

DepartmentsData

{
  "FieldId": "string",
  "DataFields": {
    "Company": null,
    "Division": "string",
    "Station": "string",
    "DepartmentName": "string",
    "DepartmentHead": "string",
    "ParentDepartment": "string"
  }
}

Departments Data

Properties

Name Type Required Restrictions Description
FieldId string false none none
DataFields DepartmentsDataFields false none JSON Object of Data Fields

DepartmentsDataFields

{
  "Company": null,
  "Division": "string",
  "Station": "string",
  "DepartmentName": "string",
  "DepartmentHead": "string",
  "ParentDepartment": "string"
}

Departments Data Fields

Properties

Name Type Required Restrictions Description
Company Sting false none none
Division string false none none
Station string false none none
DepartmentName string false none none
DepartmentHead string false none none
ParentDepartment string false none none

CustomFieldsList

{
  "RecordId": "string",
  "ComponentName": "string",
  "CustomFieldName": "string",
  "CustomFieldCategory": "string",
  "MandatoryField": "string",
  "CustomFieldType": "string",
  "CustomFieldOrder": "string",
  "CustomFieldPosition": "string",
  "CustomFieldTypeValues": null,
  "Instructions": "string"
}

Custom Fields List

Properties

Name Type Required Restrictions Description
RecordId string false none none
ComponentName string false none none
CustomFieldName string false none none
CustomFieldCategory string false none none
MandatoryField string false none none
CustomFieldType string false none none
CustomFieldOrder string false none none
CustomFieldPosition string false none none
CustomFieldTypeValues Array false none none
Instructions string false none none

UpdateCustomField

{
  "RecordId": "string",
  "CustomFieldName": "string",
  "CustomFieldCategory": "string",
  "MandatoryField": "string",
  "CustomFieldType": "string",
  "CustomFieldOrder": "string",
  "CustomFieldPosition": "string",
  "CustomFieldTypeValues": null
}

Update Custom Field

Properties

Name Type Required Restrictions Description
RecordId string false none none
CustomFieldName string false none none
CustomFieldCategory string false none none
MandatoryField string false none none
CustomFieldType string false none none
CustomFieldOrder string false none none
CustomFieldPosition string false none none
CustomFieldTypeValues Array false none none

CustomFieldDependencies

{
  "RecordId": "string",
  "Source": "string",
  "Destination": "string",
  "SourceOption": "string",
  "DestinationOptions": null,
  "SourceId": 0,
  "DestinationId": 0
}

CustomField Dependencies List

Properties

Name Type Required Restrictions Description
RecordId string false none none
Source string false none none
Destination string false none none
SourceOption string false none none
DestinationOptions Array false none none
SourceId integer false none none
DestinationId integer false none none

Employees

{
  "Status": 1,
  "Summary": {
    "Page": 1,
    "RecordsPerPage": 10,
    "TotalRecords": 0,
    "Offset": 0,
    "NumberOfPages": 0,
    "Search": "string",
    "NextPageURL": "string"
  },
  "Data": [
    {
      "FieldId": "string",
      "DataFields": {
        "UserName": "string",
        "AccessCode": "string",
        "FirstName": "string",
        "LastName": "string",
        "MiddleName": "string",
        "FullName": "string",
        "EmailAddress": "string",
        "Status": "string",
        "Designation": "string",
        "CompanyName": "string",
        "DivisionName": "string",
        "DepartmentName": "string",
        "StationName": "string",
        "EmployeeCategory": "string",
        "EmployeeType": "string",
        "JoiningDate": "string",
        "GovernmentId": "string",
        "DateOfBirth": "string",
        "Gender": "string",
        "MaritalStatus": "string",
        "BloodGroup": "string",
        "PresentContactNumber": "string",
        "MobileNumber": "string",
        "OfficePhoneNumber": "string",
        "PositionCode": "string",
        "ReportsTo": "string",
        "PermanentAddress": "string",
        "PermanentCity": "string",
        "PermanentState": "string",
        "PermanentCountry": "string",
        "PresentAddress": "string",
        "PresentCity": "string",
        "PresentState": "string",
        "PresentCountry": "string"
      }
    }
  ]
}

Employees

Properties

Name Type Required Restrictions Description
Status integer false none 0 -> Fail
1 -> Success
Summary Summary false none JSON Object of Summary
Data [EmployeesData] false none JSON Array of Data Fields

EmployeesData

{
  "FieldId": "string",
  "DataFields": {
    "UserName": "string",
    "AccessCode": "string",
    "FirstName": "string",
    "LastName": "string",
    "MiddleName": "string",
    "FullName": "string",
    "EmailAddress": "string",
    "Status": "string",
    "Designation": "string",
    "CompanyName": "string",
    "DivisionName": "string",
    "DepartmentName": "string",
    "StationName": "string",
    "EmployeeCategory": "string",
    "EmployeeType": "string",
    "JoiningDate": "string",
    "GovernmentId": "string",
    "DateOfBirth": "string",
    "Gender": "string",
    "MaritalStatus": "string",
    "BloodGroup": "string",
    "PresentContactNumber": "string",
    "MobileNumber": "string",
    "OfficePhoneNumber": "string",
    "PositionCode": "string",
    "ReportsTo": "string",
    "PermanentAddress": "string",
    "PermanentCity": "string",
    "PermanentState": "string",
    "PermanentCountry": "string",
    "PresentAddress": "string",
    "PresentCity": "string",
    "PresentState": "string",
    "PresentCountry": "string"
  }
}

Employees Data

Properties

Name Type Required Restrictions Description
FieldId string false none none
DataFields EmployeeDataFields false none JSON Object of Data Fields

EmployeeDataFields

{
  "UserName": "string",
  "AccessCode": "string",
  "FirstName": "string",
  "LastName": "string",
  "MiddleName": "string",
  "FullName": "string",
  "EmailAddress": "string",
  "Status": "string",
  "Designation": "string",
  "CompanyName": "string",
  "DivisionName": "string",
  "DepartmentName": "string",
  "StationName": "string",
  "EmployeeCategory": "string",
  "EmployeeType": "string",
  "JoiningDate": "string",
  "GovernmentId": "string",
  "DateOfBirth": "string",
  "Gender": "string",
  "MaritalStatus": "string",
  "BloodGroup": "string",
  "PresentContactNumber": "string",
  "MobileNumber": "string",
  "OfficePhoneNumber": "string",
  "PositionCode": "string",
  "ReportsTo": "string",
  "PermanentAddress": "string",
  "PermanentCity": "string",
  "PermanentState": "string",
  "PermanentCountry": "string",
  "PresentAddress": "string",
  "PresentCity": "string",
  "PresentState": "string",
  "PresentCountry": "string"
}

Employees

Properties

Name Type Required Restrictions Description
UserName string false none none
AccessCode string false none none
FirstName string false none none
LastName string false none none
MiddleName string false none none
FullName string false none none
EmailAddress string false none none
Status string false none none
Designation string false none none
CompanyName string false none none
DivisionName string false none none
DepartmentName string false none none
StationName string false none none
EmployeeCategory string false none none
EmployeeType string false none none
JoiningDate string false none none
GovernmentId string false none none
DateOfBirth string false none none
Gender string false none none
MaritalStatus string false none none
BloodGroup string false none none
PresentContactNumber string false none none
MobileNumber string false none none
OfficePhoneNumber string false none none
PositionCode string false none none
ReportsTo string false none none
PermanentAddress string false none none
PermanentCity string false none none
PermanentState string false none none
PermanentCountry string false none none
PresentAddress string false none none
PresentCity string false none none
PresentState string false none none
PresentCountry string false none none

AddEmployees

{
  "CompanyName": "string",
  "DivisionName": "string",
  "StationName": "string",
  "DepartmentName": "string",
  "Designation": "string",
  "Grade": "string",
  "WorkShift": "string",
  "EmployeeCategory": "string",
  "EmployeeType": "string",
  "UserName": "string",
  "FirstName": "string",
  "LastName": "string",
  "Password": "string",
  "AllowLogin": "string",
  "EmailAddress": "string",
  "ShowInOrganogram": "string",
  "AccessCode": "string",
  "ReportsTo": "string",
  "Supervisor": "string",
  "Salutation": "string",
  "Nickname": "string",
  "DateofBirth": "string",
  "Gender": "string",
  "BloodGroup": "string",
  "Nationality": "string",
  "Religion": "string",
  "MaritalStatus": "string",
  "JoiningDate": "string",
  "GovernmentId": "string",
  "EmployeeTaxNumber": "string",
  "PresentAddress": "string",
  "PresentCity": "string",
  "PresentState": "string",
  "PresentZipCode": "string",
  "PresentCountry": "string",
  "PresentContactNumber": "string",
  "PermanentAddress": "string",
  "PermanentCity": "string",
  "PermanentState": "string",
  "PermanentZipCode": "string",
  "PermanentCountry": "string",
  "PermanentContactNumber": "string",
  "HomePhoneNumber": "string",
  "OfficePhoneNumber": "string",
  "MobileNumber": "string",
  "PassportNumber": "string",
  "PassportExpiration": "string"
}

Add Employees

Properties

Name Type Required Restrictions Description
CompanyName string false none none
DivisionName string false none none
StationName string false none none
DepartmentName string false none none
Designation string false none none
Grade string false none none
WorkShift string false none none
EmployeeCategory string false none none
EmployeeType string false none none
UserName string false none none
FirstName string false none none
LastName string false none none
Password string false none none
AllowLogin string false none none
EmailAddress string false none none
ShowInOrganogram string false none none
AccessCode string false none none
ReportsTo string false none none
Supervisor string false none none
Salutation string false none none
Nickname string false none none
DateofBirth string false none none
Gender string false none none
BloodGroup string false none none
Nationality string false none none
Religion string false none none
MaritalStatus string false none none
JoiningDate string false none none
GovernmentId string false none none
EmployeeTaxNumber string false none none
PresentAddress string false none none
PresentCity string false none none
PresentState string false none none
PresentZipCode string false none none
PresentCountry string false none none
PresentContactNumber string false none none
PermanentAddress string false none none
PermanentCity string false none none
PermanentState string false none none
PermanentZipCode string false none none
PermanentCountry string false none none
PermanentContactNumber string false none none
HomePhoneNumber string false none none
OfficePhoneNumber string false none none
MobileNumber string false none none
PassportNumber string false none none
PassportExpiration string false none none

Transfers

{
  "Status": 1,
  "Summary": {
    "Page": 1,
    "RecordsPerPage": 10,
    "TotalRecords": 0,
    "Offset": 0,
    "NumberOfPages": 0,
    "Search": "string",
    "NextPageURL": "string"
  },
  "Data": [
    {
      "FieldId": "string",
      "DataFields": {
        "Username": "string",
        "FirstName": "string",
        "LastName": "string",
        "FullName": "string",
        "TransferDate": null,
        "TransferToStation": "string",
        "TransferToDepartment": "string",
        "OpenPositionCode": null,
        "Designation": null
      }
    }
  ]
}

Transfers

Properties

Name Type Required Restrictions Description
Status integer false none 0 -> Fail
1 -> Success
Summary Summary false none JSON Object of Summary
Data [TransfersData] false none JSON Array of Data Fields

TransfersData

{
  "FieldId": "string",
  "DataFields": {
    "Username": "string",
    "FirstName": "string",
    "LastName": "string",
    "FullName": "string",
    "TransferDate": null,
    "TransferToStation": "string",
    "TransferToDepartment": "string",
    "OpenPositionCode": null,
    "Designation": null
  }
}

Transfers Data

Properties

Name Type Required Restrictions Description
FieldId string false none none
DataFields TransfersDataFields false none JSON Object of Data Fields

TransfersDataFields

{
  "Username": "string",
  "FirstName": "string",
  "LastName": "string",
  "FullName": "string",
  "TransferDate": null,
  "TransferToStation": "string",
  "TransferToDepartment": "string",
  "OpenPositionCode": null,
  "Designation": null
}

Employees_Transfers

Properties

Name Type Required Restrictions Description
Username string false none none
FirstName string false none none
LastName string false none none
FullName string false none none
TransferDate date false none none
TransferToStation string false none none
TransferToDepartment string false none none
OpenPositionCode Integer false none none
Designation Integer false none none

Exit

{
  "Status": 1,
  "Summary": {
    "Page": 1,
    "RecordsPerPage": 10,
    "TotalRecords": 0,
    "Offset": 0,
    "NumberOfPages": 0,
    "Search": "string",
    "NextPageURL": "string"
  },
  "Data": [
    {
      "FieldId": "string",
      "DataFields": {
        "Username": "string",
        "FirstName": "string",
        "LastName": "string",
        "FullName": "string",
        "ExitDate": null,
        "CompanyName": "string",
        "StationName": "string",
        "DivisionName": "string",
        "ExitType": "string",
        "ExitInterviewConducted": "string"
      }
    }
  ]
}

Exit

Properties

Name Type Required Restrictions Description
Status integer false none 0 -> Fail
1 -> Success
Summary Summary false none JSON Object of Summary
Data [ExitData] false none JSON Array of Data Fields

ExitData

{
  "FieldId": "string",
  "DataFields": {
    "Username": "string",
    "FirstName": "string",
    "LastName": "string",
    "FullName": "string",
    "ExitDate": null,
    "CompanyName": "string",
    "StationName": "string",
    "DivisionName": "string",
    "ExitType": "string",
    "ExitInterviewConducted": "string"
  }
}

Exit Data

Properties

Name Type Required Restrictions Description
FieldId string false none none
DataFields ExitDataFields false none JSON Object of Data Fields

ExitDataFields

{
  "Username": "string",
  "FirstName": "string",
  "LastName": "string",
  "FullName": "string",
  "ExitDate": null,
  "CompanyName": "string",
  "StationName": "string",
  "DivisionName": "string",
  "ExitType": "string",
  "ExitInterviewConducted": "string"
}

Employees_Exits

Properties

Name Type Required Restrictions Description
Username string false none none
FirstName string false none none
LastName string false none none
FullName string false none none
ExitDate date false none none
CompanyName string false none none
StationName string false none none
DivisionName string false none none
ExitType string false none none
ExitInterviewConducted string false none none

Resignations

{
  "Status": 1,
  "Summary": {
    "Page": 1,
    "RecordsPerPage": 10,
    "TotalRecords": 0,
    "Offset": 0,
    "NumberOfPages": 0,
    "Search": "string",
    "NextPageURL": "string"
  },
  "Data": [
    {
      "FieldId": "string",
      "DataFields": {
        "Username": "string",
        "Empoyee": "string",
        "ResignationDate": null,
        "NoticeDate": null
      }
    }
  ]
}

Resignations

Properties

Name Type Required Restrictions Description
Status integer false none 0 -> Fail
1 -> Success
Summary Summary false none JSON Object of Summary
Data [ResignationsData] false none JSON Array of Data Fields

ResignationsData

{
  "FieldId": "string",
  "DataFields": {
    "Username": "string",
    "Empoyee": "string",
    "ResignationDate": null,
    "NoticeDate": null
  }
}

Resignations Data

Properties

Name Type Required Restrictions Description
FieldId string false none none
DataFields ResignationsDataFields false none JSON Object of Data Fields

ResignationsDataFields

{
  "Username": "string",
  "Empoyee": "string",
  "ResignationDate": null,
  "NoticeDate": null
}

Resignations

Properties

Name Type Required Restrictions Description
Username string false none none
Empoyee string false none none
ResignationDate date false none none
NoticeDate date false none none

Terminations

{
  "Status": 1,
  "Summary": {
    "Page": 1,
    "RecordsPerPage": 10,
    "TotalRecords": 0,
    "Offset": 0,
    "NumberOfPages": 0,
    "Search": "string",
    "NextPageURL": "string"
  },
  "Data": [
    {
      "FieldId": "string",
      "DataFields": {
        "Username": "string",
        "Empoyee": "string",
        "TerminationType": "string",
        "TerminationDate": null,
        "NoticeDate": null
      }
    }
  ]
}

Terminations

Properties

Name Type Required Restrictions Description
Status integer false none 0 -> Fail
1 -> Success
Summary Summary false none JSON Object of Summary
Data [TerminationsData] false none JSON Array of Data Fields

TerminationsData

{
  "FieldId": "string",
  "DataFields": {
    "Username": "string",
    "Empoyee": "string",
    "TerminationType": "string",
    "TerminationDate": null,
    "NoticeDate": null
  }
}

Terminations Data

Properties

Name Type Required Restrictions Description
FieldId string false none none
DataFields TerminationsDataFields false none JSON Object of Data Fields

TerminationsDataFields

{
  "Username": "string",
  "Empoyee": "string",
  "TerminationType": "string",
  "TerminationDate": null,
  "NoticeDate": null
}

Terminations

Properties

Name Type Required Restrictions Description
Username string false none none
Empoyee string false none none
TerminationType string false none none
TerminationDate date false none none
NoticeDate date false none none

Achievements

{
  "Status": 1,
  "Summary": {
    "Page": 1,
    "RecordsPerPage": 10,
    "TotalRecords": 0,
    "Offset": 0,
    "NumberOfPages": 0,
    "Search": "string",
    "NextPageURL": "string"
  },
  "Data": [
    {
      "FieldId": "string",
      "DataFields": {
        "Username": "string",
        "Empoyee": "string",
        "AchievementTitle": "string",
        "AchievementDate": null
      }
    }
  ]
}

Achievements

Properties

Name Type Required Restrictions Description
Status integer false none 0 -> Fail
1 -> Success
Summary Summary false none JSON Object of Summary
Data [AchievementsData] false none JSON Array of Data Fields

AchievementsData

{
  "FieldId": "string",
  "DataFields": {
    "Username": "string",
    "Empoyee": "string",
    "AchievementTitle": "string",
    "AchievementDate": null
  }
}

Achievements Data

Properties

Name Type Required Restrictions Description
FieldId string false none none
DataFields AchievementsDataFields false none JSON Object of Data Fields

AchievementsDataFields

{
  "Username": "string",
  "Empoyee": "string",
  "AchievementTitle": "string",
  "AchievementDate": null
}

Achievements

Properties

Name Type Required Restrictions Description
Username string false none none
Empoyee string false none none
AchievementTitle string false none none
AchievementDate date false none none

Complaints

{
  "Status": 1,
  "Summary": {
    "Page": 1,
    "RecordsPerPage": 10,
    "TotalRecords": 0,
    "Offset": 0,
    "NumberOfPages": 0,
    "Search": "string",
    "NextPageURL": "string"
  },
  "Data": [
    {
      "FieldId": "string",
      "DataFields": {
        "Username": "string",
        "Empoyee": "string",
        "Title": "string",
        "ComplaintDate": null,
        "ComplaintAgainst": null
      }
    }
  ]
}

Complaints

Properties

Name Type Required Restrictions Description
Status integer false none 0 -> Fail
1 -> Success
Summary Summary false none JSON Object of Summary
Data [ComplaintsData] false none JSON Array of Data Fields

ComplaintsData

{
  "FieldId": "string",
  "DataFields": {
    "Username": "string",
    "Empoyee": "string",
    "Title": "string",
    "ComplaintDate": null,
    "ComplaintAgainst": null
  }
}

Complaints Data

Properties

Name Type Required Restrictions Description
FieldId string false none none
DataFields ComplaintsDataFields false none JSON Object of Data Fields

ComplaintsDataFields

{
  "Username": "string",
  "Empoyee": "string",
  "Title": "string",
  "ComplaintDate": null,
  "ComplaintAgainst": null
}

Complaints

Properties

Name Type Required Restrictions Description
Username string false none none
Empoyee string false none none
Title string false none none
ComplaintDate date false none none
ComplaintAgainst Array false none none

Warnings

{
  "Status": 1,
  "Summary": {
    "Page": 1,
    "RecordsPerPage": 10,
    "TotalRecords": 0,
    "Offset": 0,
    "NumberOfPages": 0,
    "Search": "string",
    "NextPageURL": "string"
  },
  "Data": [
    {
      "FieldId": "string",
      "DataFields": {
        "WarningByEmployee": "string",
        "WarningToEmployee": "string",
        "WarningDate": null,
        "TypeOfWarning": "string",
        "Subject": "string"
      }
    }
  ]
}

Warnings

Properties

Name Type Required Restrictions Description
Status integer false none 0 -> Fail
1 -> Success
Summary Summary false none JSON Object of Summary
Data [WarningsData] false none JSON Array of Data Fields

WarningsData

{
  "FieldId": "string",
  "DataFields": {
    "WarningByEmployee": "string",
    "WarningToEmployee": "string",
    "WarningDate": null,
    "TypeOfWarning": "string",
    "Subject": "string"
  }
}

Warnings Data

Properties

Name Type Required Restrictions Description
FieldId string false none none
DataFields WarningsDataFields false none JSON Object of Data Fields

WarningsDataFields

{
  "WarningByEmployee": "string",
  "WarningToEmployee": "string",
  "WarningDate": null,
  "TypeOfWarning": "string",
  "Subject": "string"
}

Warnings

Properties

Name Type Required Restrictions Description
WarningByEmployee string false none none
WarningToEmployee string false none none
WarningDate date false none none
TypeOfWarning string false none none
Subject string false none none

Memos

{
  "Status": 1,
  "Summary": {
    "Page": 1,
    "RecordsPerPage": 10,
    "TotalRecords": 0,
    "Offset": 0,
    "NumberOfPages": 0,
    "Search": "string",
    "NextPageURL": "string"
  },
  "Data": [
    {
      "FieldId": "string",
      "DataFields": {
        "UserName": "string",
        "Employee": "string",
        "MemoDate": null,
        "Subject": "string",
        "MemoTo": null
      }
    }
  ]
}

Memos

Properties

Name Type Required Restrictions Description
Status integer false none 0 -> Fail
1 -> Success
Summary Summary false none JSON Object of Summary
Data [MemosData] false none JSON Array of Data Fields

MemosData

{
  "FieldId": "string",
  "DataFields": {
    "UserName": "string",
    "Employee": "string",
    "MemoDate": null,
    "Subject": "string",
    "MemoTo": null
  }
}

Memos Data

Properties

Name Type Required Restrictions Description
FieldId string false none none
DataFields MemosDataFields false none JSON Object of Data Fields

MemosDataFields

{
  "UserName": "string",
  "Employee": "string",
  "MemoDate": null,
  "Subject": "string",
  "MemoTo": null
}

Memos

Properties

Name Type Required Restrictions Description
UserName string false none none
Employee string false none none
MemoDate date false none none
Subject string false none none
MemoTo Array false none none

Suggestions

{
  "Status": 1,
  "Summary": {
    "Page": 1,
    "RecordsPerPage": 10,
    "TotalRecords": 0,
    "Offset": 0,
    "NumberOfPages": 0,
    "Search": "string",
    "NextPageURL": "string"
  },
  "Data": [
    {
      "FieldId": "string",
      "DataFields": {
        "UserName": "string",
        "Employee": "string",
        "Title": "string"
      }
    }
  ]
}

Suggestions

Properties

Name Type Required Restrictions Description
Status integer false none 0 -> Fail
1 -> Success
Summary Summary false none JSON Object of Summary
Data [SuggestionsData] false none JSON Array of Data Fields

SuggestionsData

{
  "FieldId": "string",
  "DataFields": {
    "UserName": "string",
    "Employee": "string",
    "Title": "string"
  }
}

Suggestions Data

Properties

Name Type Required Restrictions Description
FieldId string false none none
DataFields SuggestionsDataFields false none JSON Object of Data Fields

SuggestionsDataFields

{
  "UserName": "string",
  "Employee": "string",
  "Title": "string"
}

Suggestions Data Fields

Properties

Name Type Required Restrictions Description
UserName string false none none
Employee string false none none
Title string false none none

Attendance

{
  "Status": 1,
  "Summary": {
    "Page": 1,
    "RecordsPerPage": 10,
    "TotalRecords": 0,
    "Offset": 0,
    "NumberOfPages": 0,
    "Search": "string",
    "NextPageURL": "string"
  },
  "Data": [
    {
      "FieldId": "string",
      "DataFields": {
        "Username": "string",
        "FirstName": "string",
        "LastName": "string",
        "FullName": "string",
        "AttendanceDate": null,
        "SignInTime": null,
        "SignOutTime": null,
        "LunchBreakOutTime": null,
        "LunchBreakInTime": null,
        "AdditionalBreakOutTime": null,
        "AdditionalBreakInTime": null,
        "ExtraBreakOutTime": null,
        "ExtraBreakInTime": null,
        "BreakOutTime": null,
        "TotalTime": null,
        "ApprovalStatus": "string",
        "Approver": "string"
      }
    }
  ]
}

Attendance

Properties

Name Type Required Restrictions Description
Status integer false none 0 -> Fail
1 -> Success
Summary Summary false none JSON Object of Summary
Data [AttendanceData] false none JSON Array of Data Fields

AttendanceData

{
  "FieldId": "string",
  "DataFields": {
    "Username": "string",
    "FirstName": "string",
    "LastName": "string",
    "FullName": "string",
    "AttendanceDate": null,
    "SignInTime": null,
    "SignOutTime": null,
    "LunchBreakOutTime": null,
    "LunchBreakInTime": null,
    "AdditionalBreakOutTime": null,
    "AdditionalBreakInTime": null,
    "ExtraBreakOutTime": null,
    "ExtraBreakInTime": null,
    "BreakOutTime": null,
    "TotalTime": null,
    "ApprovalStatus": "string",
    "Approver": "string"
  }
}

Attendance Data

Properties

Name Type Required Restrictions Description
FieldId string false none none
DataFields AttendanceDataFields false none JSON Object of Data Fields

AttendanceDataFields

{
  "Username": "string",
  "FirstName": "string",
  "LastName": "string",
  "FullName": "string",
  "AttendanceDate": null,
  "SignInTime": null,
  "SignOutTime": null,
  "LunchBreakOutTime": null,
  "LunchBreakInTime": null,
  "AdditionalBreakOutTime": null,
  "AdditionalBreakInTime": null,
  "ExtraBreakOutTime": null,
  "ExtraBreakInTime": null,
  "BreakOutTime": null,
  "TotalTime": null,
  "ApprovalStatus": "string",
  "Approver": "string"
}

Attendance Data Fields

Properties

Name Type Required Restrictions Description
Username string false none none
FirstName string false none none
LastName string false none none
FullName string false none none
AttendanceDate date false none none
SignInTime datetime false none none
SignOutTime datetime false none none
LunchBreakOutTime datetime false none none
LunchBreakInTime datetime false none none
AdditionalBreakOutTime datetime false none none
AdditionalBreakInTime datetime false none none
ExtraBreakOutTime datetime false none none
ExtraBreakInTime datetime false none none
BreakOutTime datetime false none none
TotalTime datetime false none none
ApprovalStatus string false none none
Approver string false none none

AddAttendance

{
  "AccessCode": "string",
  "Date": null,
  "Time": null,
  "Type": "string",
  "WorkShift": "string"
}

Add Attendance

Properties

Name Type Required Restrictions Description
AccessCode string false none none
Date date false none none
Time datetime false none none
Type string false none none
WorkShift string false none none

Leaves

{
  "Status": 1,
  "Summary": {
    "Page": 1,
    "RecordsPerPage": 10,
    "TotalRecords": 0,
    "Offset": 0,
    "NumberOfPages": 0,
    "Search": "string",
    "NextPageURL": "string"
  },
  "Data": [
    {
      "FieldId": "string",
      "DataFields": {
        "Username": "string",
        "FirstName": "string",
        "LastName": "string",
        "FullName": "string",
        "Reason": "string",
        "ReferenceNumber": "string",
        "LeaveType": "string",
        "LunchBreakOutTime": null,
        "LeaveFrom": null,
        "LeaveTo": null,
        "LeaveHours": "string",
        "ApprovalStatus": "string"
      }
    }
  ]
}

Leaves

Properties

Name Type Required Restrictions Description
Status integer false none 0 -> Fail
1 -> Success
Summary Summary false none JSON Object of Summary
Data [LeavesData] false none JSON Array of Data Fields

LeavesData

{
  "FieldId": "string",
  "DataFields": {
    "Username": "string",
    "FirstName": "string",
    "LastName": "string",
    "FullName": "string",
    "Reason": "string",
    "ReferenceNumber": "string",
    "LeaveType": "string",
    "LunchBreakOutTime": null,
    "LeaveFrom": null,
    "LeaveTo": null,
    "LeaveHours": "string",
    "ApprovalStatus": "string"
  }
}

Leaves Data

Properties

Name Type Required Restrictions Description
FieldId string false none none
DataFields LeavesDataFields false none JSON Object of Data Fields

LeavesDataFields

{
  "Username": "string",
  "FirstName": "string",
  "LastName": "string",
  "FullName": "string",
  "Reason": "string",
  "ReferenceNumber": "string",
  "LeaveType": "string",
  "LunchBreakOutTime": null,
  "LeaveFrom": null,
  "LeaveTo": null,
  "LeaveHours": "string",
  "ApprovalStatus": "string"
}

Leaves Data Fields

Properties

Name Type Required Restrictions Description
Username string false none none
FirstName string false none none
LastName string false none none
FullName string false none none
Reason string false none none
ReferenceNumber string false none none
LeaveType string false none none
LunchBreakOutTime datetime false none none
LeaveFrom date false none none
LeaveTo date false none none
LeaveHours string false none none
ApprovalStatus string false none none

AddLeave

{
  "UserName": "string",
  "LeaveFrom": null,
  "LeaveTo": null,
  "LeaveType": "string",
  "LeaveDuration": "string"
}

Add Leave

Properties

Name Type Required Restrictions Description
UserName string false none none
LeaveFrom date false none none
LeaveTo date false none none
LeaveType string false none none
LeaveDuration string false none none

LeavesQuota

{
  "Status": 1,
  "Summary": {
    "Page": 1,
    "RecordsPerPage": 10,
    "TotalRecords": 0,
    "Offset": 0,
    "NumberOfPages": 0,
    "Search": "string",
    "NextPageURL": "string"
  },
  "Data": [
    {
      "FieldId": "string",
      "DataFields": {
        "Year": "string",
        "Employee": "string",
        "UserName": "string",
        "AccessCode": "string",
        "EmployeeType": "string",
        "EmployeeCategory": null,
        "LeaveType": null,
        "Entitled": null,
        "Accrued": "string",
        "CarriedOver": "string",
        "Additional": null,
        "Adjusted": null,
        "Taken": null,
        "Pending": "string",
        "Balance": "string"
      }
    }
  ]
}

Leaves Quota

Properties

Name Type Required Restrictions Description
Status integer false none 0 -> Fail
1 -> Success
Summary Summary false none JSON Object of Summary
Data [LeavesQuotaData] false none JSON Array of Data Fields

LeavesQuotaData

{
  "FieldId": "string",
  "DataFields": {
    "Year": "string",
    "Employee": "string",
    "UserName": "string",
    "AccessCode": "string",
    "EmployeeType": "string",
    "EmployeeCategory": null,
    "LeaveType": null,
    "Entitled": null,
    "Accrued": "string",
    "CarriedOver": "string",
    "Additional": null,
    "Adjusted": null,
    "Taken": null,
    "Pending": "string",
    "Balance": "string"
  }
}

Leaves Quota Data

Properties

Name Type Required Restrictions Description
FieldId string false none none
DataFields LeavesQuotaDataFields false none JSON Object of Data Fields

LeavesQuotaDataFields

{
  "Year": "string",
  "Employee": "string",
  "UserName": "string",
  "AccessCode": "string",
  "EmployeeType": "string",
  "EmployeeCategory": null,
  "LeaveType": null,
  "Entitled": null,
  "Accrued": "string",
  "CarriedOver": "string",
  "Additional": null,
  "Adjusted": null,
  "Taken": null,
  "Pending": "string",
  "Balance": "string"
}

Leaves Quota Data Fields

Properties

Name Type Required Restrictions Description
Year string false none none
Employee string false none none
UserName string false none none
AccessCode string false none none
EmployeeType string false none none
EmployeeCategory datetime false none none
LeaveType date false none none
Entitled date false none none
Accrued string false none none
CarriedOver string false none none
Additional datetime false none none
Adjusted date false none none
Taken date false none none
Pending string false none none
Balance string false none none

EmployeeHours

{
  "Status": 1,
  "Summary": {
    "Page": 1,
    "RecordsPerPage": 10,
    "TotalRecords": 0,
    "Offset": 0,
    "NumberOfPages": 0,
    "Search": "string",
    "NextPageURL": "string"
  },
  "Data": [
    {
      "FieldId": "string",
      "DataFields": {
        "RecordId": "string",
        "UserName": "string",
        "Employee": "string",
        "Project": "string",
        "EmployeeHoursDate": null,
        "RegularHours": 0,
        "OvertimeHours": 0
      }
    }
  ]
}

Employee Hours

Properties

Name Type Required Restrictions Description
Status integer false none 0 -> Fail
1 -> Success
Summary Summary false none JSON Object of Summary
Data [EmployeeHoursData] false none JSON Array of Data Fields

EmployeeHoursData

{
  "FieldId": "string",
  "DataFields": {
    "RecordId": "string",
    "UserName": "string",
    "Employee": "string",
    "Project": "string",
    "EmployeeHoursDate": null,
    "RegularHours": 0,
    "OvertimeHours": 0
  }
}

Employee Hours Data

Properties

Name Type Required Restrictions Description
FieldId string false none none
DataFields EmployeeHoursDataFields false none JSON Object of Data Fields

EmployeeHoursDataFields

{
  "RecordId": "string",
  "UserName": "string",
  "Employee": "string",
  "Project": "string",
  "EmployeeHoursDate": null,
  "RegularHours": 0,
  "OvertimeHours": 0
}

Employee Hours Data Fields

Properties

Name Type Required Restrictions Description
RecordId string false none none
UserName string false none none
Employee string false none none
Project string false none none
EmployeeHoursDate date false none none
RegularHours integer false none none
OvertimeHours integer false none none

Projects

{
  "Status": 1,
  "Summary": {
    "Page": 1,
    "RecordsPerPage": 10,
    "TotalRecords": 0,
    "Offset": 0,
    "NumberOfPages": 0,
    "Search": "string",
    "NextPageURL": "string"
  },
  "Data": [
    {
      "FieldId": "string",
      "DataFields": {
        "RecordId": "string",
        "ProjectTitle": "string",
        "ProjectCode": "string",
        "ClientName": "string",
        "ProjectCategoryName": null,
        "ProjectStartDate": null,
        "ProjectEndDate": null,
        "ProjectManager": "string",
        "ProjectCoordinator": "string",
        "ProjectEmployees": "string"
      }
    }
  ]
}

Projects

Properties

Name Type Required Restrictions Description
Status integer false none 0 -> Fail
1 -> Success
Summary Summary false none JSON Object of Summary
Data [ProjectsData] false none JSON Array of Data Fields

ProjectsData

{
  "FieldId": "string",
  "DataFields": {
    "RecordId": "string",
    "ProjectTitle": "string",
    "ProjectCode": "string",
    "ClientName": "string",
    "ProjectCategoryName": null,
    "ProjectStartDate": null,
    "ProjectEndDate": null,
    "ProjectManager": "string",
    "ProjectCoordinator": "string",
    "ProjectEmployees": "string"
  }
}

Projects Data

Properties

Name Type Required Restrictions Description
FieldId string false none none
DataFields ProjectsDataFields false none JSON Object of Data Fields

ProjectsDataFields

{
  "RecordId": "string",
  "ProjectTitle": "string",
  "ProjectCode": "string",
  "ClientName": "string",
  "ProjectCategoryName": null,
  "ProjectStartDate": null,
  "ProjectEndDate": null,
  "ProjectManager": "string",
  "ProjectCoordinator": "string",
  "ProjectEmployees": "string"
}

Projects Data Fields

Properties

Name Type Required Restrictions Description
RecordId string false none none
ProjectTitle string false none none
ProjectCode string false none none
ClientName string false none none
ProjectCategoryName date false none none
ProjectStartDate date false none none
ProjectEndDate date false none none
ProjectManager string false none none
ProjectCoordinator string false none none
ProjectEmployees string false none none

ProjectsTasks

{
  "Status": 1,
  "Summary": {
    "Page": 1,
    "RecordsPerPage": 10,
    "TotalRecords": 0,
    "Offset": 0,
    "NumberOfPages": 0,
    "Search": "string",
    "NextPageURL": "string"
  },
  "Data": [
    {
      "FieldId": "string",
      "DataFields": {
        "Task": "string",
        "TaskType": "string",
        "ProjectTitle": "string",
        "ClientName": "string",
        "TaskStartDate": null,
        "TaskEndDate": null,
        "Deadline": null,
        "AssignedTo": []
      }
    }
  ]
}

Projects Tasks

Properties

Name Type Required Restrictions Description
Status integer false none 0 -> Fail
1 -> Success
Summary Summary false none JSON Object of Summary
Data [ProjectsTasksData] false none JSON Array of Data Fields

ProjectsTasksData

{
  "FieldId": "string",
  "DataFields": {
    "Task": "string",
    "TaskType": "string",
    "ProjectTitle": "string",
    "ClientName": "string",
    "TaskStartDate": null,
    "TaskEndDate": null,
    "Deadline": null,
    "AssignedTo": []
  }
}

Projects Tasks Data

Properties

Name Type Required Restrictions Description
FieldId string false none none
DataFields ProjectsTasksDataFields false none JSON Object of Data Fields

ProjectsTasksDataFields

{
  "Task": "string",
  "TaskType": "string",
  "ProjectTitle": "string",
  "ClientName": "string",
  "TaskStartDate": null,
  "TaskEndDate": null,
  "Deadline": null,
  "AssignedTo": []
}

Projects Tasks Data Fields

Properties

Name Type Required Restrictions Description
Task string false none none
TaskType string false none none
ProjectTitle string false none none
ClientName string false none none
TaskStartDate date false none none
TaskEndDate date false none none
Deadline date false none none
AssignedTo array false none none

ProjectsTasksParams

{
  "Task": "string",
  "TaskType": "string",
  "ProjectTitle": "string",
  "Deadline": null,
  "AssignedTo": [],
  "TaskStartDate": null,
  "TaskEndDate": null,
  "TaskStartTime": "string",
  "TaskEndTime": "string",
  "MaxHoursBy": "string",
  "MaxHours": "string",
  "TaskRateRegular": "string",
  "TaskRateOvertime": "string",
  "TaskBillRateRegular": "string",
  "TaskBillRateOvertime": "string",
  "Description": "string"
}

Projects Tasks Params

Properties

Name Type Required Restrictions Description
Task string false none none
TaskType string false none none
ProjectTitle string false none none
Deadline date false none none
AssignedTo array false none none
TaskStartDate date false none none
TaskEndDate date false none none
TaskStartTime string false none none
TaskEndTime string false none none
MaxHoursBy string false none none
MaxHours string false none none
TaskRateRegular string false none none
TaskRateOvertime string false none none
TaskBillRateRegular string false none none
TaskBillRateOvertime string false none none
Description string false none none

ProjectsClients

{
  "Status": 1,
  "Summary": {
    "Page": 1,
    "RecordsPerPage": 10,
    "TotalRecords": 0,
    "Offset": 0,
    "NumberOfPages": 0,
    "Search": "string",
    "NextPageURL": "string"
  },
  "Data": [
    {
      "FieldId": "string",
      "DataFields": {
        "ClientName": "string",
        "FirstName": "string",
        "LastName": "string",
        "EmailAddress": "string",
        "PhoneNumber": "string",
        "Address": "string",
        "City": "string",
        "State": "string",
        "Country": "string",
        "ZipCode": "string"
      }
    }
  ]
}

Projects Clients

Properties

Name Type Required Restrictions Description
Status integer false none 0 -> Fail
1 -> Success
Summary Summary false none JSON Object of Summary
Data [ProjectsClientsData] false none JSON Array of Data Fields

ProjectsClientsData

{
  "FieldId": "string",
  "DataFields": {
    "ClientName": "string",
    "FirstName": "string",
    "LastName": "string",
    "EmailAddress": "string",
    "PhoneNumber": "string",
    "Address": "string",
    "City": "string",
    "State": "string",
    "Country": "string",
    "ZipCode": "string"
  }
}

Projects Clients Data

Properties

Name Type Required Restrictions Description
FieldId string false none none
DataFields ProjectsClientsDataFields false none JSON Object of Data Fields

ProjectsClientsDataFields

{
  "ClientName": "string",
  "FirstName": "string",
  "LastName": "string",
  "EmailAddress": "string",
  "PhoneNumber": "string",
  "Address": "string",
  "City": "string",
  "State": "string",
  "Country": "string",
  "ZipCode": "string"
}

Projects Clients Data Fields

Properties

Name Type Required Restrictions Description
ClientName string false none none
FirstName string false none none
LastName string false none none
EmailAddress string false none none
PhoneNumber string false none none
Address string false none none
City string false none none
State string false none none
Country string false none none
ZipCode string false none none

JobPosts

{
  "Status": 1,
  "Summary": {
    "Page": 1,
    "RecordsPerPage": 10,
    "TotalRecords": 0,
    "Offset": 0,
    "NumberOfPages": 0,
    "Search": "string",
    "NextPageURL": "string"
  },
  "Data": [
    {
      "FieldId": "string",
      "DataFields": {
        "JobTitle": "string",
        "ReferenceNumber": null,
        "JobType": "string",
        "NumberOfPositions": 0,
        "CandidateAgeRangeStart": 0,
        "CandidateAgeRangeEnd": 0,
        "CandidateExperience": "string",
        "CandidateQualification": "string",
        "Description": "string",
        "SalaryStartRange": "string",
        "SalaryEndRange": "string",
        "JobPostCompany": "string",
        "JobPostDepartment": "string",
        "JobPostStation": "string"
      }
    }
  ]
}

Job Posts

Properties

Name Type Required Restrictions Description
Status integer false none 0 -> Fail
1 -> Success
Summary Summary false none JSON Object of Summary
Data [JobPostsData] false none JSON Array of Data Fields

JobPostsData

{
  "FieldId": "string",
  "DataFields": {
    "JobTitle": "string",
    "ReferenceNumber": null,
    "JobType": "string",
    "NumberOfPositions": 0,
    "CandidateAgeRangeStart": 0,
    "CandidateAgeRangeEnd": 0,
    "CandidateExperience": "string",
    "CandidateQualification": "string",
    "Description": "string",
    "SalaryStartRange": "string",
    "SalaryEndRange": "string",
    "JobPostCompany": "string",
    "JobPostDepartment": "string",
    "JobPostStation": "string"
  }
}

Job Posts Data

Properties

Name Type Required Restrictions Description
FieldId string false none none
DataFields JobPostsDataFields false none JSON Object of Data Fields

JobPostsDataFields

{
  "JobTitle": "string",
  "ReferenceNumber": null,
  "JobType": "string",
  "NumberOfPositions": 0,
  "CandidateAgeRangeStart": 0,
  "CandidateAgeRangeEnd": 0,
  "CandidateExperience": "string",
  "CandidateQualification": "string",
  "Description": "string",
  "SalaryStartRange": "string",
  "SalaryEndRange": "string",
  "JobPostCompany": "string",
  "JobPostDepartment": "string",
  "JobPostStation": "string"
}

Job Posts Data Fields

Properties

Name Type Required Restrictions Description
JobTitle string false none none
ReferenceNumber integet false none none
JobType string false none none
NumberOfPositions integer false none none
CandidateAgeRangeStart integer false none none
CandidateAgeRangeEnd integer false none none
CandidateExperience string false none none
CandidateQualification string false none none
Description string false none none
SalaryStartRange string false none none
SalaryEndRange string false none none
JobPostCompany string false none none
JobPostDepartment string false none none
JobPostStation string false none none

JobRequests

{
  "Status": 1,
  "Summary": {
    "Page": 1,
    "RecordsPerPage": 10,
    "TotalRecords": 0,
    "Offset": 0,
    "NumberOfPages": 0,
    "Search": "string",
    "NextPageURL": "string"
  },
  "Data": [
    {
      "FieldId": "string",
      "DataFields": {
        "JobTitle": "string",
        "ReferenceNumber": 0,
        "JobType": "string",
        "NumberOfPositions": 0,
        "CandidateAgeRangeStart": 0,
        "CandidateAgeRangeEnd": 0,
        "CandidateExperience": "string",
        "CandidateQualification": "string",
        "Description": "string",
        "SalaryStartRange": "string",
        "SalaryEndRange": "string"
      }
    }
  ]
}

Job Requests

Properties

Name Type Required Restrictions Description
Status integer false none 0 -> Fail
1 -> Success
Summary Summary false none JSON Object of Summary
Data [JobRequestsData] false none JSON Array of Data Fields

JobRequestsData

{
  "FieldId": "string",
  "DataFields": {
    "JobTitle": "string",
    "ReferenceNumber": 0,
    "JobType": "string",
    "NumberOfPositions": 0,
    "CandidateAgeRangeStart": 0,
    "CandidateAgeRangeEnd": 0,
    "CandidateExperience": "string",
    "CandidateQualification": "string",
    "Description": "string",
    "SalaryStartRange": "string",
    "SalaryEndRange": "string"
  }
}

Job Requests Data

Properties

Name Type Required Restrictions Description
FieldId string false none none
DataFields JobRequestsFields false none JSON Object of Data Fields

JobRequestsFields

{
  "JobTitle": "string",
  "ReferenceNumber": 0,
  "JobType": "string",
  "NumberOfPositions": 0,
  "CandidateAgeRangeStart": 0,
  "CandidateAgeRangeEnd": 0,
  "CandidateExperience": "string",
  "CandidateQualification": "string",
  "Description": "string",
  "SalaryStartRange": "string",
  "SalaryEndRange": "string"
}

Job Requests Fields

Properties

Name Type Required Restrictions Description
JobTitle string false none none
ReferenceNumber integer false none none
JobType string false none none
NumberOfPositions integer false none none
CandidateAgeRangeStart integer false none none
CandidateAgeRangeEnd integer false none none
CandidateExperience string false none none
CandidateQualification string false none none
Description string false none none
SalaryStartRange string false none none
SalaryEndRange string false none none

JobCandidatesList

{
  "Status": 1,
  "Summary": {
    "Page": 1,
    "RecordsPerPage": 10,
    "TotalRecords": 0,
    "Offset": 0,
    "NumberOfPages": 0,
    "Search": "string",
    "NextPageURL": "string"
  },
  "Data": [
    {
      "FieldId": "string",
      "DataFields": {
        "FirstName": "string",
        "LastName": 0,
        "DateOfBirth": "string",
        "Gender": 0,
        "Nationality": 0,
        "Address": 0,
        "City": "string",
        "EmailAddress": "string",
        "PhoneNumber": "string",
        "MobileNumber": "string",
        "JobField": "string",
        "AppliedOn": null,
        "Qualifications": null,
        "Experience": null,
        "Membership": null,
        "Trainings": null,
        "Languages": null,
        "Skills": null,
        "References": null,
        "CustomFields": null
      }
    }
  ]
}

Job Candidates List

Properties

Name Type Required Restrictions Description
Status integer false none 0 -> Fail
1 -> Success
Summary Summary false none JSON Object of Summary
Data [JobCandidatesListData] false none JSON Array of Data Fields

JobCandidatesListData

{
  "FieldId": "string",
  "DataFields": {
    "FirstName": "string",
    "LastName": 0,
    "DateOfBirth": "string",
    "Gender": 0,
    "Nationality": 0,
    "Address": 0,
    "City": "string",
    "EmailAddress": "string",
    "PhoneNumber": "string",
    "MobileNumber": "string",
    "JobField": "string",
    "AppliedOn": null,
    "Qualifications": null,
    "Experience": null,
    "Membership": null,
    "Trainings": null,
    "Languages": null,
    "Skills": null,
    "References": null,
    "CustomFields": null
  }
}

Job Candidates List Data

Properties

Name Type Required Restrictions Description
FieldId string false none none
DataFields JobCandidatesListDataFields false none JSON Object of Data Fields

JobCandidatesListDataFields

{
  "FirstName": "string",
  "LastName": 0,
  "DateOfBirth": "string",
  "Gender": 0,
  "Nationality": 0,
  "Address": 0,
  "City": "string",
  "EmailAddress": "string",
  "PhoneNumber": "string",
  "MobileNumber": "string",
  "JobField": "string",
  "AppliedOn": null,
  "Qualifications": null,
  "Experience": null,
  "Membership": null,
  "Trainings": null,
  "Languages": null,
  "Skills": null,
  "References": null,
  "CustomFields": null
}

Job Candidates List Data Fields

Properties

Name Type Required Restrictions Description
FirstName string false none none
LastName integer false none none
DateOfBirth string false none none
Gender integer false none none
Nationality integer false none none
Address integer false none none
City string false none none
EmailAddress string false none none
PhoneNumber string false none none
MobileNumber string false none none
JobField string false none none
AppliedOn date false none none
Qualifications Array false none none
Experience Array false none none
Membership Array false none none
Trainings Array false none none
Languages Array false none none
Skills Array false none none
References Array false none none
CustomFields Array false none none

AddCandidate

{
  "JobField": "string",
  "FirstName": "string",
  "LastName": "string",
  "DateOfBirth": "string",
  "Gender": "string",
  "Address": "string",
  "City": "string",
  "ZipCode": "string",
  "Country": "string",
  "EmailAddress": "string",
  "PhoneNumber": "string",
  "Interests": null,
  "Achievements": null,
  "ResourceSource": "string",
  "ResourceSourceDetails": "string"
}

Add Candidate

Properties

Name Type Required Restrictions Description
JobField string false none none
FirstName string false none none
LastName string false none none
DateOfBirth string false none none
Gender string false none none
Address string false none none
City string false none none
ZipCode string false none none
Country string false none none
EmailAddress string false none none
PhoneNumber string false none none
Interests Array false none none
Achievements Array false none none
ResourceSource string false none none
ResourceSourceDetails string false none none

ScreeningInterviews

{
  "Status": 1,
  "Summary": {
    "Page": 1,
    "RecordsPerPage": 10,
    "TotalRecords": 0,
    "Offset": 0,
    "NumberOfPages": 0,
    "Search": "string",
    "NextPageURL": "string"
  },
  "Data": [
    {
      "FieldId": "string",
      "DataFields": {
        "InterviewType": "string",
        "InterviewDate": null,
        "InterviewTime": null,
        "PlaceOfInterview": "string",
        "CandidateName": "string",
        "CandidateEmailAddress": "string",
        "CandidateReferenceNumber": 0
      }
    }
  ]
}

Screening Interviews

Properties

Name Type Required Restrictions Description
Status integer false none 0 -> Fail
1 -> Success
Summary Summary false none JSON Object of Summary
Data [ScreeningInterviewsData] false none JSON Array of Data Fields

ScreeningInterviewsData

{
  "FieldId": "string",
  "DataFields": {
    "InterviewType": "string",
    "InterviewDate": null,
    "InterviewTime": null,
    "PlaceOfInterview": "string",
    "CandidateName": "string",
    "CandidateEmailAddress": "string",
    "CandidateReferenceNumber": 0
  }
}

Screening Interviews Data

Properties

Name Type Required Restrictions Description
FieldId string false none none
DataFields ScreeningInterviewsDataFields false none JSON Object of Data Fields

ScreeningInterviewsDataFields

{
  "InterviewType": "string",
  "InterviewDate": null,
  "InterviewTime": null,
  "PlaceOfInterview": "string",
  "CandidateName": "string",
  "CandidateEmailAddress": "string",
  "CandidateReferenceNumber": 0
}

Screening Interviews Data Fields

Properties

Name Type Required Restrictions Description
InterviewType string false none none
InterviewDate Date false none none
InterviewTime datetime false none none
PlaceOfInterview string false none none
CandidateName string false none none
CandidateEmailAddress string false none none
CandidateReferenceNumber integer false none none

Loans

{
  "Status": 1,
  "Summary": {
    "Page": 1,
    "RecordsPerPage": 10,
    "TotalRecords": 0,
    "Offset": 0,
    "NumberOfPages": 0,
    "Search": "string",
    "NextPageURL": "string"
  },
  "Data": [
    {
      "FieldId": "string",
      "DataFields": {
        "Employee": "string",
        "UserName": "string",
        "Title": "string",
        "LoanAmount": "string",
        "RemainingAmount": "string",
        "MonthlyRepaymentAmount": "string",
        "RepaymentsType": "string",
        "RepaymentsMonths": "string",
        "LoanDate": null,
        "RepaymentStartDate": null,
        "Interest": "string",
        "InterestType": "string",
        "TotalLoanPaid": "string"
      }
    }
  ]
}

Loans

Properties

Name Type Required Restrictions Description
Status integer false none 0 -> Fail
1 -> Success
Summary Summary false none JSON Object of Summary
Data [LoansData] false none JSON Array of Data Fields

LoansData

{
  "FieldId": "string",
  "DataFields": {
    "Employee": "string",
    "UserName": "string",
    "Title": "string",
    "LoanAmount": "string",
    "RemainingAmount": "string",
    "MonthlyRepaymentAmount": "string",
    "RepaymentsType": "string",
    "RepaymentsMonths": "string",
    "LoanDate": null,
    "RepaymentStartDate": null,
    "Interest": "string",
    "InterestType": "string",
    "TotalLoanPaid": "string"
  }
}

Loans Data

Properties

Name Type Required Restrictions Description
FieldId string false none none
DataFields LoansDataFields false none JSON Object of Data Fields

LoansDataFields

{
  "Employee": "string",
  "UserName": "string",
  "Title": "string",
  "LoanAmount": "string",
  "RemainingAmount": "string",
  "MonthlyRepaymentAmount": "string",
  "RepaymentsType": "string",
  "RepaymentsMonths": "string",
  "LoanDate": null,
  "RepaymentStartDate": null,
  "Interest": "string",
  "InterestType": "string",
  "TotalLoanPaid": "string"
}

Loans Data Fields

Properties

Name Type Required Restrictions Description
Employee string false none none
UserName string false none none
Title string false none none
LoanAmount string false none none
RemainingAmount string false none none
MonthlyRepaymentAmount string false none none
RepaymentsType string false none none
RepaymentsMonths string false none none
LoanDate date false none none
RepaymentStartDate date false none none
Interest string false none none
InterestType string false none none
TotalLoanPaid string false none none

Payslips

{
  "Status": 1,
  "Summary": {
    "Page": 1,
    "RecordsPerPage": 10,
    "TotalRecords": 0,
    "Offset": 0,
    "NumberOfPages": 0,
    "Search": "string",
    "NextPageURL": "string"
  },
  "Data": [
    {
      "FieldId": "string",
      "DataFields": {
        "CompanyName": "string",
        "StationName": "string",
        "DivisionName": "string",
        "UserName": "string",
        "AccessCode": "string",
        "FirstName": "string",
        "LastName": "string",
        "FullName": "string",
        "Nationality": "string",
        "PositionCode": "string",
        "TotalSalary": "string",
        "PayslipItems": null,
        "AdditionalItems": null,
        "SalaryDate": null,
        "SalaryPeriod_StartDate": null,
        "SalaryPeriod_EndDate": null,
        "ApprovalStatus": "string"
      }
    }
  ]
}

Payslips

Properties

Name Type Required Restrictions Description
Status integer false none 0 -> Fail
1 -> Success
Summary Summary false none JSON Object of Summary
Data [PayslipsData] false none JSON Array of Data Fields

PayslipsData

{
  "FieldId": "string",
  "DataFields": {
    "CompanyName": "string",
    "StationName": "string",
    "DivisionName": "string",
    "UserName": "string",
    "AccessCode": "string",
    "FirstName": "string",
    "LastName": "string",
    "FullName": "string",
    "Nationality": "string",
    "PositionCode": "string",
    "TotalSalary": "string",
    "PayslipItems": null,
    "AdditionalItems": null,
    "SalaryDate": null,
    "SalaryPeriod_StartDate": null,
    "SalaryPeriod_EndDate": null,
    "ApprovalStatus": "string"
  }
}

Payslips Data

Properties

Name Type Required Restrictions Description
FieldId string false none none
DataFields PayslipsDataFields false none JSON Object of Data Fields

PayslipsDataFields

{
  "CompanyName": "string",
  "StationName": "string",
  "DivisionName": "string",
  "UserName": "string",
  "AccessCode": "string",
  "FirstName": "string",
  "LastName": "string",
  "FullName": "string",
  "Nationality": "string",
  "PositionCode": "string",
  "TotalSalary": "string",
  "PayslipItems": null,
  "AdditionalItems": null,
  "SalaryDate": null,
  "SalaryPeriod_StartDate": null,
  "SalaryPeriod_EndDate": null,
  "ApprovalStatus": "string"
}

Payslips Data Fields

Properties

Name Type Required Restrictions Description
CompanyName string false none none
StationName string false none none
DivisionName string false none none
UserName string false none none
AccessCode string false none none
FirstName string false none none
LastName string false none none
FullName string false none none
Nationality string false none none
PositionCode string false none none
TotalSalary string false none none
PayslipItems Array false none none
AdditionalItems Array false none none
SalaryDate date false none none
SalaryPeriod_StartDate date false none none
SalaryPeriod_EndDate date false none none
ApprovalStatus string false none none

Salary

{
  "Status": 1,
  "Summary": {
    "Page": 1,
    "RecordsPerPage": 10,
    "TotalRecords": 0,
    "Offset": 0,
    "NumberOfPages": 0,
    "Search": "string",
    "NextPageURL": "string"
  },
  "Data": [
    {
      "FieldId": "string",
      "DataFields": {
        "Employee": "string",
        "UserName": "string",
        "PayrollSetup": "string",
        "SalaryType": "string",
        "Currency": "string",
        "AnnualGrossSalary": null,
        "MonthlyGrossSalary": null,
        "HourlySalary": null,
        "OvertimeHourlySalary": null,
        "HoursPerWeek": null,
        "PayrollItems": null
      }
    }
  ]
}

Salary

Properties

Name Type Required Restrictions Description
Status integer false none 0 -> Fail
1 -> Success
Summary Summary false none JSON Object of Summary
Data [SalaryData] false none JSON Array of Data Fields

SalaryData

{
  "FieldId": "string",
  "DataFields": {
    "Employee": "string",
    "UserName": "string",
    "PayrollSetup": "string",
    "SalaryType": "string",
    "Currency": "string",
    "AnnualGrossSalary": null,
    "MonthlyGrossSalary": null,
    "HourlySalary": null,
    "OvertimeHourlySalary": null,
    "HoursPerWeek": null,
    "PayrollItems": null
  }
}

Salary Data

Properties

Name Type Required Restrictions Description
FieldId string false none none
DataFields SalaryDataFields false none JSON Object of Data Fields

SalaryDataFields

{
  "Employee": "string",
  "UserName": "string",
  "PayrollSetup": "string",
  "SalaryType": "string",
  "Currency": "string",
  "AnnualGrossSalary": null,
  "MonthlyGrossSalary": null,
  "HourlySalary": null,
  "OvertimeHourlySalary": null,
  "HoursPerWeek": null,
  "PayrollItems": null
}

Salary Data Fields

Properties

Name Type Required Restrictions Description
Employee string false none none
UserName string false none none
PayrollSetup string false none none
SalaryType string false none none
Currency string false none none
AnnualGrossSalary decimal false none none
MonthlyGrossSalary decimal false none none
HourlySalary decimal false none none
OvertimeHourlySalary decimal false none none
HoursPerWeek decimal false none none
PayrollItems Array false none none

AdvanceSalary

{
  "Status": 1,
  "Summary": {
    "Page": 1,
    "RecordsPerPage": 10,
    "TotalRecords": 0,
    "Offset": 0,
    "NumberOfPages": 0,
    "Search": "string",
    "NextPageURL": "string"
  },
  "Data": [
    {
      "FieldId": "string",
      "DataFields": {
        "Employee": "string",
        "UserName": "string",
        "Title": "string",
        "Amount": "string",
        "AdvanceSalaryDate": null
      }
    }
  ]
}

AdvanceSalary

Properties

Name Type Required Restrictions Description
Status integer false none 0 -> Fail
1 -> Success
Summary Summary false none JSON Object of Summary
Data [AdvanceSalaryData] false none JSON Array of Data Fields

AdvanceSalaryData

{
  "FieldId": "string",
  "DataFields": {
    "Employee": "string",
    "UserName": "string",
    "Title": "string",
    "Amount": "string",
    "AdvanceSalaryDate": null
  }
}

AdvanceSalary Data

Properties

Name Type Required Restrictions Description
FieldId string false none none
DataFields AdvanceSalaryDataFields false none JSON Object of Data Fields

AdvanceSalaryDataFields

{
  "Employee": "string",
  "UserName": "string",
  "Title": "string",
  "Amount": "string",
  "AdvanceSalaryDate": null
}

AdvanceSalary Data Fields

Properties

Name Type Required Restrictions Description
Employee string false none none
UserName string false none none
Title string false none none
Amount string false none none
AdvanceSalaryDate date false none none

Earnings

{
  "Status": 1,
  "Summary": {
    "Page": 1,
    "RecordsPerPage": 10,
    "TotalRecords": 0,
    "Offset": 0,
    "NumberOfPages": 0,
    "Search": "string",
    "NextPageURL": "string"
  },
  "Data": [
    {
      "FieldId": "string",
      "DataFields": {
        "Employee": "string",
        "UserName": "string",
        "Title": "string",
        "Amount": "string",
        "EarningDate": null,
        "EarningType": "string"
      }
    }
  ]
}

Earnings

Properties

Name Type Required Restrictions Description
Status integer false none 0 -> Fail
1 -> Success
Summary Summary false none JSON Object of Summary
Data [EarningsData] false none JSON Array of Data Fields

EarningsData

{
  "FieldId": "string",
  "DataFields": {
    "Employee": "string",
    "UserName": "string",
    "Title": "string",
    "Amount": "string",
    "EarningDate": null,
    "EarningType": "string"
  }
}

Earnings Data

Properties

Name Type Required Restrictions Description
FieldId string false none none
DataFields EarningsDataFields false none JSON Object of Data Fields

EarningsDataFields

{
  "Employee": "string",
  "UserName": "string",
  "Title": "string",
  "Amount": "string",
  "EarningDate": null,
  "EarningType": "string"
}

Earnings Data Fields

Properties

Name Type Required Restrictions Description
Employee string false none none
UserName string false none none
Title string false none none
Amount string false none none
EarningDate date false none none
EarningType string false none none

Bonuses

{
  "Status": 1,
  "Summary": {
    "Page": 1,
    "RecordsPerPage": 10,
    "TotalRecords": 0,
    "Offset": 0,
    "NumberOfPages": 0,
    "Search": "string",
    "NextPageURL": "string"
  },
  "Data": [
    {
      "FieldId": "string",
      "DataFields": {
        "Employee": "string",
        "UserName": "string",
        "Title": "string",
        "Amount": "string",
        "BonusDate": null
      }
    }
  ]
}

Bonuses

Properties

Name Type Required Restrictions Description
Status integer false none 0 -> Fail
1 -> Success
Summary Summary false none JSON Object of Summary
Data [BonusesData] false none JSON Array of Data Fields

BonusesData

{
  "FieldId": "string",
  "DataFields": {
    "Employee": "string",
    "UserName": "string",
    "Title": "string",
    "Amount": "string",
    "BonusDate": null
  }
}

Bonuses Data

Properties

Name Type Required Restrictions Description
FieldId string false none none
DataFields BonusesDataFields false none JSON Object of Data Fields

BonusesDataFields

{
  "Employee": "string",
  "UserName": "string",
  "Title": "string",
  "Amount": "string",
  "BonusDate": null
}

Bonuses Data Fields

Properties

Name Type Required Restrictions Description
Employee string false none none
UserName string false none none
Title string false none none
Amount string false none none
BonusDate date false none none

Commissions

{
  "Status": 1,
  "Summary": {
    "Page": 1,
    "RecordsPerPage": 10,
    "TotalRecords": 0,
    "Offset": 0,
    "NumberOfPages": 0,
    "Search": "string",
    "NextPageURL": "string"
  },
  "Data": [
    {
      "FieldId": "string",
      "DataFields": {
        "Employee": "string",
        "UserName": "string",
        "Title": "string",
        "Amount": "string",
        "CommissionDate": null
      }
    }
  ]
}

Commissions

Properties

Name Type Required Restrictions Description
Status integer false none 0 -> Fail
1 -> Success
Summary Summary false none JSON Object of Summary
Data [CommissionsData] false none JSON Array of Data Fields

CommissionsData

{
  "FieldId": "string",
  "DataFields": {
    "Employee": "string",
    "UserName": "string",
    "Title": "string",
    "Amount": "string",
    "CommissionDate": null
  }
}

Commissions Data

Properties

Name Type Required Restrictions Description
FieldId string false none none
DataFields CommissionsDataFields false none JSON Object of Data Fields

CommissionsDataFields

{
  "Employee": "string",
  "UserName": "string",
  "Title": "string",
  "Amount": "string",
  "CommissionDate": null
}

Commissions Data Fields

Properties

Name Type Required Restrictions Description
Employee string false none none
UserName string false none none
Title string false none none
Amount string false none none
CommissionDate date false none none

Deductions

{
  "Status": 1,
  "Summary": {
    "Page": 1,
    "RecordsPerPage": 10,
    "TotalRecords": 0,
    "Offset": 0,
    "NumberOfPages": 0,
    "Search": "string",
    "NextPageURL": "string"
  },
  "Data": [
    {
      "FieldId": "string",
      "DataFields": {
        "Employee": "string",
        "UserName": "string",
        "Title": "string",
        "Amount": "string",
        "DeductionDate": null,
        "DeductionType": "string"
      }
    }
  ]
}

Deductions

Properties

Name Type Required Restrictions Description
Status integer false none 0 -> Fail
1 -> Success
Summary Summary false none JSON Object of Summary
Data [DeductionsData] false none JSON Array of Data Fields

DeductionsData

{
  "FieldId": "string",
  "DataFields": {
    "Employee": "string",
    "UserName": "string",
    "Title": "string",
    "Amount": "string",
    "DeductionDate": null,
    "DeductionType": "string"
  }
}

Deductions Data

Properties

Name Type Required Restrictions Description
FieldId string false none none
DataFields DeductionsDataFields false none JSON Object of Data Fields

DeductionsDataFields

{
  "Employee": "string",
  "UserName": "string",
  "Title": "string",
  "Amount": "string",
  "DeductionDate": null,
  "DeductionType": "string"
}

Deductions Data Fields

Properties

Name Type Required Restrictions Description
Employee string false none none
UserName string false none none
Title string false none none
Amount string false none none
DeductionDate date false none none
DeductionType string false none none

RecurringDeductions

{
  "Status": 1,
  "Summary": {
    "Page": 1,
    "RecordsPerPage": 10,
    "TotalRecords": 0,
    "Offset": 0,
    "NumberOfPages": 0,
    "Search": "string",
    "NextPageURL": "string"
  },
  "Data": [
    {
      "FieldId": "string",
      "DataFields": {
        "Employee": "string",
        "Title": "string",
        "Amount": "string",
        "RecurringDeductionEndDate": null,
        "DeductionType": "string"
      }
    }
  ]
}

Recurring Deductions

Properties

Name Type Required Restrictions Description
Status integer false none 0 -> Fail
1 -> Success
Summary Summary false none JSON Object of Summary
Data [RecurringDeductionsData] false none JSON Array of Data Fields

RecurringDeductionsData

{
  "FieldId": "string",
  "DataFields": {
    "Employee": "string",
    "Title": "string",
    "Amount": "string",
    "RecurringDeductionEndDate": null,
    "DeductionType": "string"
  }
}

Recurring Deductions Data

Properties

Name Type Required Restrictions Description
FieldId string false none none
DataFields RecurringDeductionsDataFields false none JSON Object of Data Fields

RecurringDeductionsDataFields

{
  "Employee": "string",
  "Title": "string",
  "Amount": "string",
  "RecurringDeductionEndDate": null,
  "DeductionType": "string"
}

Recurring Deductions Data Fields

Properties

Name Type Required Restrictions Description
Employee string false none none
Title string false none none
Amount string false none none
RecurringDeductionEndDate date false none none
DeductionType string false none none

Adjustments

{
  "Status": 1,
  "Summary": {
    "Page": 1,
    "RecordsPerPage": 10,
    "TotalRecords": 0,
    "Offset": 0,
    "NumberOfPages": 0,
    "Search": "string",
    "NextPageURL": "string"
  },
  "Data": [
    {
      "FieldId": "string",
      "DataFields": {
        "Employee": "string",
        "UserName": "string",
        "Title": "string",
        "Amount": "string",
        "AdjustmentDate": null,
        "AdjustmentType": "string"
      }
    }
  ]
}

Adjustments

Properties

Name Type Required Restrictions Description
Status integer false none 0 -> Fail
1 -> Success
Summary Summary false none JSON Object of Summary
Data [AdjustmentsData] false none JSON Array of Data Fields

AdjustmentsData

{
  "FieldId": "string",
  "DataFields": {
    "Employee": "string",
    "UserName": "string",
    "Title": "string",
    "Amount": "string",
    "AdjustmentDate": null,
    "AdjustmentType": "string"
  }
}

Adjustments Data

Properties

Name Type Required Restrictions Description
FieldId string false none none
DataFields AdjustmentsDataFields false none JSON Object of Data Fields

AdjustmentsDataFields

{
  "Employee": "string",
  "UserName": "string",
  "Title": "string",
  "Amount": "string",
  "AdjustmentDate": null,
  "AdjustmentType": "string"
}

Adjustments Data Fields

Properties

Name Type Required Restrictions Description
Employee string false none none
UserName string false none none
Title string false none none
Amount string false none none
AdjustmentDate date false none none
AdjustmentType string false none none

RecurringAdjustments

{
  "Status": 1,
  "Summary": {
    "Page": 1,
    "RecordsPerPage": 10,
    "TotalRecords": 0,
    "Offset": 0,
    "NumberOfPages": 0,
    "Search": "string",
    "NextPageURL": "string"
  },
  "Data": [
    {
      "FieldId": "string",
      "DataFields": {
        "Employee": "string",
        "Title": "string",
        "Amount": "string",
        "StartDate": null,
        "EndDate": null,
        "AdjustmentType": "string"
      }
    }
  ]
}

Recurring Adjustments

Properties

Name Type Required Restrictions Description
Status integer false none 0 -> Fail
1 -> Success
Summary Summary false none JSON Object of Summary
Data [RecurringAdjustmentsData] false none JSON Array of Data Fields

RecurringAdjustmentsData

{
  "FieldId": "string",
  "DataFields": {
    "Employee": "string",
    "Title": "string",
    "Amount": "string",
    "StartDate": null,
    "EndDate": null,
    "AdjustmentType": "string"
  }
}

Recurring Adjustments Data

Properties

Name Type Required Restrictions Description
FieldId string false none none
DataFields RecurringAdjustmentsDataFields false none JSON Object of Data Fields

RecurringAdjustmentsDataFields

{
  "Employee": "string",
  "Title": "string",
  "Amount": "string",
  "StartDate": null,
  "EndDate": null,
  "AdjustmentType": "string"
}

Recurring Adjustments Data Fields

Properties

Name Type Required Restrictions Description
Employee string false none none
Title string false none none
Amount string false none none
StartDate date false none none
EndDate date false none none
AdjustmentType string false none none

HourlyWages

{
  "Status": 1,
  "Summary": {
    "Page": 1,
    "RecordsPerPage": 10,
    "TotalRecords": 0,
    "Offset": 0,
    "NumberOfPages": 0,
    "Search": "string",
    "NextPageURL": "string"
  },
  "Data": [
    {
      "FieldId": "string",
      "DataFields": {
        "Employee": "string",
        "UserName": "string",
        "Title": "string",
        "HourlyWageDate": null,
        "RegularHours": "string",
        "OvertimeHours": "string"
      }
    }
  ]
}

HourlyWages

Properties

Name Type Required Restrictions Description
Status integer false none 0 -> Fail
1 -> Success
Summary Summary false none JSON Object of Summary
Data [HourlyWagesData] false none JSON Array of Data Fields

HourlyWagesData

{
  "FieldId": "string",
  "DataFields": {
    "Employee": "string",
    "UserName": "string",
    "Title": "string",
    "HourlyWageDate": null,
    "RegularHours": "string",
    "OvertimeHours": "string"
  }
}

Hourly Wages Data

Properties

Name Type Required Restrictions Description
FieldId string false none none
DataFields HourlyWagesDataFields false none JSON Object of Data Fields

HourlyWagesDataFields

{
  "Employee": "string",
  "UserName": "string",
  "Title": "string",
  "HourlyWageDate": null,
  "RegularHours": "string",
  "OvertimeHours": "string"
}

Hourly Wages Data Fields

Properties

Name Type Required Restrictions Description
Employee string false none none
UserName string false none none
Title string false none none
HourlyWageDate date false none none
RegularHours string false none none
OvertimeHours string false none none

Insurance

{
  "Status": 1,
  "Summary": {
    "Page": 1,
    "RecordsPerPage": 10,
    "TotalRecords": 0,
    "Offset": 0,
    "NumberOfPages": 0,
    "Search": "string",
    "NextPageURL": "string"
  },
  "Data": [
    {
      "FieldId": "string",
      "DataFields": {
        "Employee": "string",
        "UserName": "string",
        "Title": "string",
        "InsuranceType": "string",
        "EmployeeShareAmount": null,
        "OrganizationShareAmount": null,
        "ExpiryDate": null
      }
    }
  ]
}

Insurance

Properties

Name Type Required Restrictions Description
Status integer false none 0 -> Fail
1 -> Success
Summary Summary false none JSON Object of Summary
Data [InsuranceData] false none JSON Array of Data Fields

InsuranceData

{
  "FieldId": "string",
  "DataFields": {
    "Employee": "string",
    "UserName": "string",
    "Title": "string",
    "InsuranceType": "string",
    "EmployeeShareAmount": null,
    "OrganizationShareAmount": null,
    "ExpiryDate": null
  }
}

Insurance Data

Properties

Name Type Required Restrictions Description
FieldId string false none none
DataFields InsuranceDataFields false none JSON Object of Data Fields

InsuranceDataFields

{
  "Employee": "string",
  "UserName": "string",
  "Title": "string",
  "InsuranceType": "string",
  "EmployeeShareAmount": null,
  "OrganizationShareAmount": null,
  "ExpiryDate": null
}

Insurance Data Fields

Properties

Name Type Required Restrictions Description
Employee string false none none
UserName string false none none
Title string false none none
InsuranceType string false none none
EmployeeShareAmount decimal false none none
OrganizationShareAmount decimal false none none
ExpiryDate date false none none

Reimbursements

{
  "Status": 1,
  "Summary": {
    "Page": 1,
    "RecordsPerPage": 10,
    "TotalRecords": 0,
    "Offset": 0,
    "NumberOfPages": 0,
    "Search": "string",
    "NextPageURL": "string"
  },
  "Data": [
    {
      "FieldId": "string",
      "DataFields": {
        "Employee": "string",
        "UserName": "string",
        "Title": "string",
        "ReimbursementDate": null,
        "ApprovalStatus": "string",
        "ReimbursementItems": null
      }
    }
  ]
}

Reimbursements

Properties

Name Type Required Restrictions Description
Status integer false none 0 -> Fail
1 -> Success
Summary Summary false none JSON Object of Summary
Data [ReimbursementsData] false none JSON Array of Data Fields

ReimbursementsData

{
  "FieldId": "string",
  "DataFields": {
    "Employee": "string",
    "UserName": "string",
    "Title": "string",
    "ReimbursementDate": null,
    "ApprovalStatus": "string",
    "ReimbursementItems": null
  }
}

Reimbursements Data

Properties

Name Type Required Restrictions Description
FieldId string false none none
DataFields ReimbursementsDataFields false none JSON Object of Data Fields

ReimbursementsDataFields

{
  "Employee": "string",
  "UserName": "string",
  "Title": "string",
  "ReimbursementDate": null,
  "ApprovalStatus": "string",
  "ReimbursementItems": null
}

Reimbursements Data Fields

Properties

Name Type Required Restrictions Description
Employee string false none none
UserName string false none none
Title string false none none
ReimbursementDate date false none none
ApprovalStatus string false none none
ReimbursementItems Array false none none

CostToCompany

{
  "Status": 1,
  "Summary": {
    "Page": 1,
    "RecordsPerPage": 10,
    "TotalRecords": 0,
    "Offset": 0,
    "NumberOfPages": 0,
    "Search": "string",
    "NextPageURL": "string"
  },
  "Data": [
    {
      "FieldId": "string",
      "DataFields": {
        "Employee": "string",
        "UserName": "string",
        "Title": "string",
        "CostToCompanyDate": null,
        "CostToCompanyItems": null
      }
    }
  ]
}

Cost To Company

Properties

Name Type Required Restrictions Description
Status integer false none 0 -> Fail
1 -> Success
Summary Summary false none JSON Object of Summary
Data [CostToCompanyData] false none JSON Array of Data Fields

CostToCompanyData

{
  "FieldId": "string",
  "DataFields": {
    "Employee": "string",
    "UserName": "string",
    "Title": "string",
    "CostToCompanyDate": null,
    "CostToCompanyItems": null
  }
}

Cost To Company Data

Properties

Name Type Required Restrictions Description
FieldId string false none none
DataFields CostToCompanyDataFields false none JSON Object of Data Fields

CostToCompanyDataFields

{
  "Employee": "string",
  "UserName": "string",
  "Title": "string",
  "CostToCompanyDate": null,
  "CostToCompanyItems": null
}

Cost To Company Data Fields

Properties

Name Type Required Restrictions Description
Employee string false none none
UserName string false none none
Title string false none none
CostToCompanyDate date false none none
CostToCompanyItems Array false none none

Overtimes

{
  "Status": 1,
  "Summary": {
    "Page": 1,
    "RecordsPerPage": 10,
    "TotalRecords": 0,
    "Offset": 0,
    "NumberOfPages": 0,
    "Search": "string",
    "NextPageURL": "string"
  },
  "Data": [
    {
      "FieldId": "string",
      "DataFields": {
        "Employee": "string",
        "UserName": "string",
        "Title": "string",
        "Amount": "string",
        "OvertimeDate": null,
        "OvertimeTimeIn": null,
        "OvertimeTimeOut": null
      }
    }
  ]
}

Overtimes

Properties

Name Type Required Restrictions Description
Status integer false none 0 -> Fail
1 -> Success
Summary Summary false none JSON Object of Summary
Data [OvertimesData] false none JSON Array of Data Fields

OvertimesData

{
  "FieldId": "string",
  "DataFields": {
    "Employee": "string",
    "UserName": "string",
    "Title": "string",
    "Amount": "string",
    "OvertimeDate": null,
    "OvertimeTimeIn": null,
    "OvertimeTimeOut": null
  }
}

Overtimes Data

Properties

Name Type Required Restrictions Description
FieldId string false none none
DataFields OvertimesDataFields false none JSON Object of Data Fields

OvertimesDataFields

{
  "Employee": "string",
  "UserName": "string",
  "Title": "string",
  "Amount": "string",
  "OvertimeDate": null,
  "OvertimeTimeIn": null,
  "OvertimeTimeOut": null
}

Overtimes Data Fields

Properties

Name Type Required Restrictions Description
Employee string false none none
UserName string false none none
Title string false none none
Amount string false none none
OvertimeDate date false none none
OvertimeTimeIn date false none none
OvertimeTimeOut date false none none

ProvidentFund

{
  "Status": 1,
  "Summary": {
    "Page": 1,
    "RecordsPerPage": 10,
    "TotalRecords": 0,
    "Offset": 0,
    "NumberOfPages": 0,
    "Search": "string",
    "NextPageURL": "string"
  },
  "Data": [
    {
      "FieldId": "string",
      "DataFields": {
        "Employee": "string",
        "UserName": "string",
        "ProvidentFundType": "string",
        "ProvidentFundMethod": "string",
        "EmployeeShare": "string",
        "OrganizationShare": "string"
      }
    }
  ]
}

Provident Fund

Properties

Name Type Required Restrictions Description
Status integer false none 0 -> Fail
1 -> Success
Summary Summary false none JSON Object of Summary
Data [ProvidentFundData] false none JSON Array of Data Fields

ProvidentFundData

{
  "FieldId": "string",
  "DataFields": {
    "Employee": "string",
    "UserName": "string",
    "ProvidentFundType": "string",
    "ProvidentFundMethod": "string",
    "EmployeeShare": "string",
    "OrganizationShare": "string"
  }
}

Provident Fund Data

Properties

Name Type Required Restrictions Description
FieldId string false none none
DataFields ProvidentFundDataFields false none JSON Object of Data Fields

ProvidentFundDataFields

{
  "Employee": "string",
  "UserName": "string",
  "ProvidentFundType": "string",
  "ProvidentFundMethod": "string",
  "EmployeeShare": "string",
  "OrganizationShare": "string"
}

Provident Fund Data Fields

Properties

Name Type Required Restrictions Description
Employee string false none none
UserName string false none none
ProvidentFundType string false none none
ProvidentFundMethod string false none none
EmployeeShare string false none none
OrganizationShare string false none none

FinalSettlements

{
  "Status": 1,
  "Summary": {
    "Page": 1,
    "RecordsPerPage": 10,
    "TotalRecords": 0,
    "Offset": 0,
    "NumberOfPages": 0,
    "Search": "string",
    "NextPageURL": "string"
  },
  "Data": [
    {
      "FieldId": "string",
      "DataFields": {
        "Employee": "string",
        "UserName": "string",
        "Title": "string",
        "FinalSettlementsDate": "string",
        "FinalSettlementsItems": null
      }
    }
  ]
}

Final Settlements

Properties

Name Type Required Restrictions Description
Status integer false none 0 -> Fail
1 -> Success
Summary Summary false none JSON Object of Summary
Data [FinalSettlementsData] false none JSON Array of Data Fields

FinalSettlementsData

{
  "FieldId": "string",
  "DataFields": {
    "Employee": "string",
    "UserName": "string",
    "Title": "string",
    "FinalSettlementsDate": "string",
    "FinalSettlementsItems": null
  }
}

Final Settlements Data

Properties

Name Type Required Restrictions Description
FieldId string false none none
DataFields FinalSettlementsDataFields false none JSON Object of Data Fields

FinalSettlementsDataFields

{
  "Employee": "string",
  "UserName": "string",
  "Title": "string",
  "FinalSettlementsDate": "string",
  "FinalSettlementsItems": null
}

Final Settlements Data Fields

Properties

Name Type Required Restrictions Description
Employee string false none none
UserName string false none none
Title string false none none
FinalSettlementsDate string false none none
FinalSettlementsItems Array false none none

OpenPositions

{
  "Status": 1,
  "Summary": {
    "Page": 1,
    "RecordsPerPage": 10,
    "TotalRecords": 0,
    "Offset": 0,
    "NumberOfPages": 0,
    "Search": "string",
    "NextPageURL": "string"
  },
  "Data": [
    {
      "FieldId": "string",
      "DataFields": {
        "OpenPositionCode": 0,
        "OpenPositionTitle": "string",
        "Status": "string",
        "EstimatedSalary": "string",
        "CompanyName": "string",
        "DivisionName": "string",
        "StationName": "string",
        "DepartmentName": "string"
      }
    }
  ]
}

Open Positions

Properties

Name Type Required Restrictions Description
Status integer false none 0 -> Fail
1 -> Success
Summary Summary false none JSON Object of Summary
Data [OpenPositionsData] false none JSON Array of Data Fields

OpenPositionsData

{
  "FieldId": "string",
  "DataFields": {
    "OpenPositionCode": 0,
    "OpenPositionTitle": "string",
    "Status": "string",
    "EstimatedSalary": "string",
    "CompanyName": "string",
    "DivisionName": "string",
    "StationName": "string",
    "DepartmentName": "string"
  }
}

Open Positions Data

Properties

Name Type Required Restrictions Description
FieldId string false none none
DataFields OpenPositionsDataFields false none JSON Object of Data Fields

OpenPositionsDataFields

{
  "OpenPositionCode": 0,
  "OpenPositionTitle": "string",
  "Status": "string",
  "EstimatedSalary": "string",
  "CompanyName": "string",
  "DivisionName": "string",
  "StationName": "string",
  "DepartmentName": "string"
}

Open Positions Data Fields

Properties

Name Type Required Restrictions Description
OpenPositionCode integer false none none
OpenPositionTitle string false none none
Status string false none none
EstimatedSalary string false none none
CompanyName string false none none
DivisionName string false none none
StationName string false none none
DepartmentName string false none none

JobCandidateForms

{
  "Candidate": "string",
  "SubmittedOn": "string",
  "Deadline": null,
  "FormTitle": "string",
  "FormData": null
}

Job Candidate Forms

Properties

Name Type Required Restrictions Description
Candidate string false none none
SubmittedOn string false none none
Deadline date false none none
FormTitle string false none none
FormData Array false none none

Expenses

{
  "Employee": "string",
  "UserName": "string",
  "Title": "string",
  "ExpenseDate": "string",
  "TotalAmount": "string",
  "ExpenseItems": null
}

Expenses

Properties

Name Type Required Restrictions Description
Employee string false none none
UserName string false none none
Title string false none none
ExpenseDate string false none none
TotalAmount string false none none
ExpenseItems Array false none none

Assets

{
  "Status": 1,
  "Summary": {
    "Page": 1,
    "RecordsPerPage": 10,
    "TotalRecords": 0,
    "Offset": 0,
    "NumberOfPages": 0,
    "Search": "string",
    "NextPageURL": "string"
  },
  "Data": [
    {
      "FieldId": "string",
      "DataFields": {
        "AssetName": "string",
        "AssetCode": "string",
        "AssetTag": "string",
        "Quantity": "string",
        "AssetCost": "string"
      }
    }
  ]
}

Assets

Properties

Name Type Required Restrictions Description
Status integer false none 0 -> Fail
1 -> Success
Summary Summary false none JSON Object of Summary
Data [AssetsData] false none JSON Array of Data Fields

AssetsData

{
  "FieldId": "string",
  "DataFields": {
    "AssetName": "string",
    "AssetCode": "string",
    "AssetTag": "string",
    "Quantity": "string",
    "AssetCost": "string"
  }
}

Assets Data

Properties

Name Type Required Restrictions Description
FieldId string false none none
DataFields AssetsDataFields false none JSON Object of Data Fields

AssetsDataFields

{
  "AssetName": "string",
  "AssetCode": "string",
  "AssetTag": "string",
  "Quantity": "string",
  "AssetCost": "string"
}

Assets Data Fields

Properties

Name Type Required Restrictions Description
AssetName string false none none
AssetCode string false none none
AssetTag string false none none
Quantity string false none none
AssetCost string false none none

CheckOuts

{
  "Status": 1,
  "Summary": {
    "Page": 1,
    "RecordsPerPage": 10,
    "TotalRecords": 0,
    "Offset": 0,
    "NumberOfPages": 0,
    "Search": "string",
    "NextPageURL": "string"
  },
  "Data": [
    {
      "FieldId": "string",
      "DataFields": {
        "AssetName": "string",
        "AssetCode": "string",
        "Employee": "string",
        "UserName": "string",
        "ReferenceNumber": 0,
        "CheckoutDateTime": null,
        "CheckinDateTime": null,
        "Status": "string"
      }
    }
  ]
}

Check Outs

Properties

Name Type Required Restrictions Description
Status integer false none 0 -> Fail
1 -> Success
Summary Summary false none JSON Object of Summary
Data [CheckOutsData] false none JSON Array of Data Fields

CheckOutsData

{
  "FieldId": "string",
  "DataFields": {
    "AssetName": "string",
    "AssetCode": "string",
    "Employee": "string",
    "UserName": "string",
    "ReferenceNumber": 0,
    "CheckoutDateTime": null,
    "CheckinDateTime": null,
    "Status": "string"
  }
}

Check Out Data

Properties

Name Type Required Restrictions Description
FieldId string false none none
DataFields CheckOutsDataFields false none JSON Object of Data Fields

CheckOutsDataFields

{
  "AssetName": "string",
  "AssetCode": "string",
  "Employee": "string",
  "UserName": "string",
  "ReferenceNumber": 0,
  "CheckoutDateTime": null,
  "CheckinDateTime": null,
  "Status": "string"
}

Check Out Data Fields

Properties

Name Type Required Restrictions Description
AssetName string false none none
AssetCode string false none none
Employee string false none none
UserName string false none none
ReferenceNumber integer false none none
CheckoutDateTime datetime false none none
CheckinDateTime datetime false none none
Status string false none none

EmployeeTrainings

{
  "Status": 1,
  "Summary": {
    "Page": 1,
    "RecordsPerPage": 10,
    "TotalRecords": 0,
    "Offset": 0,
    "NumberOfPages": 0,
    "Search": "string",
    "NextPageURL": "string"
  },
  "Data": [
    {
      "FieldId": "string",
      "DataFields": {
        "TrainingType": "string",
        "TrainingSubject": "string",
        "TrainingTitle": "string",
        "DateFrom": null,
        "DateTo": null
      }
    }
  ]
}

Employee Trainings

Properties

Name Type Required Restrictions Description
Status integer false none 0 -> Fail
1 -> Success
Summary Summary false none JSON Object of Summary
Data [EmployeeTrainingsData] false none JSON Array of Data Fields

EmployeeTrainingsData

{
  "FieldId": "string",
  "DataFields": {
    "TrainingType": "string",
    "TrainingSubject": "string",
    "TrainingTitle": "string",
    "DateFrom": null,
    "DateTo": null
  }
}

Employee Trainings Data

Properties

Name Type Required Restrictions Description
FieldId string false none none
DataFields EmployeeTrainingsDataFields false none JSON Object of Data Fields

EmployeeTrainingsDataFields

{
  "TrainingType": "string",
  "TrainingSubject": "string",
  "TrainingTitle": "string",
  "DateFrom": null,
  "DateTo": null
}

Employee Trainings DataFields

Properties

Name Type Required Restrictions Description
TrainingType string false none none
TrainingSubject string false none none
TrainingTitle string false none none
DateFrom datetime false none none
DateTo datetime false none none

PendingCourses

{
  "Status": 1,
  "Summary": {
    "Page": 1,
    "RecordsPerPage": 10,
    "TotalRecords": 0,
    "Offset": 0,
    "NumberOfPages": 0,
    "Search": "string",
    "NextPageURL": "string"
  },
  "Data": [
    {
      "FieldId": "string",
      "DataFields": {
        "CourseName": "string",
        "Employee": "string",
        "CourseDeadline": null,
        "TimeSpent": null,
        "Progress": "string"
      }
    }
  ]
}

Pending Courses

Properties

Name Type Required Restrictions Description
Status integer false none 0 -> Fail
1 -> Success
Summary Summary false none JSON Object of Summary
Data [PendingCoursesData] false none JSON Array of Data Fields

PendingCoursesData

{
  "FieldId": "string",
  "DataFields": {
    "CourseName": "string",
    "Employee": "string",
    "CourseDeadline": null,
    "TimeSpent": null,
    "Progress": "string"
  }
}

Pending Courses Data

Properties

Name Type Required Restrictions Description
FieldId string false none none
DataFields PendingCoursesDataFields false none JSON Object of Data Fields

PendingCoursesDataFields

{
  "CourseName": "string",
  "Employee": "string",
  "CourseDeadline": null,
  "TimeSpent": null,
  "Progress": "string"
}

Pending Courses DataFields

Properties

Name Type Required Restrictions Description
CourseName string false none none
Employee string false none none
CourseDeadline datetime false none none
TimeSpent time false none none
Progress string false none none

CompletedCourses

{
  "Status": 1,
  "Summary": {
    "Page": 1,
    "RecordsPerPage": 10,
    "TotalRecords": 0,
    "Offset": 0,
    "NumberOfPages": 0,
    "Search": "string",
    "NextPageURL": "string"
  },
  "Data": [
    {
      "FieldId": "string",
      "DataFields": {
        "CourseName": "string",
        "Employee": "string",
        "CompletedOn": null,
        "ExpectedTime": null,
        "TimeSpent": null,
        "TrainingStatus": "string",
        "TestStatus": "string"
      }
    }
  ]
}

Completed Courses

Properties

Name Type Required Restrictions Description
Status integer false none 0 -> Fail
1 -> Success
Summary Summary false none JSON Object of Summary
Data [CompletedCoursesData] false none JSON Array of Data Fields

CompletedCoursesData

{
  "FieldId": "string",
  "DataFields": {
    "CourseName": "string",
    "Employee": "string",
    "CompletedOn": null,
    "ExpectedTime": null,
    "TimeSpent": null,
    "TrainingStatus": "string",
    "TestStatus": "string"
  }
}

Completed Courses Data

Properties

Name Type Required Restrictions Description
FieldId string false none none
DataFields CompletedCoursesDataFields false none JSON Object of Data Fields

CompletedCoursesDataFields

{
  "CourseName": "string",
  "Employee": "string",
  "CompletedOn": null,
  "ExpectedTime": null,
  "TimeSpent": null,
  "TrainingStatus": "string",
  "TestStatus": "string"
}

Completed Courses DataFields

Properties

Name Type Required Restrictions Description
CourseName string false none none
Employee string false none none
CompletedOn datetime false none none
ExpectedTime time false none none
TimeSpent time false none none
TrainingStatus string false none none
TestStatus string false none none

Goals

{
  "Status": 1,
  "Summary": {
    "Page": 1,
    "RecordsPerPage": 10,
    "TotalRecords": 0,
    "Offset": 0,
    "NumberOfPages": 0,
    "Search": "string",
    "NextPageURL": "string"
  },
  "Data": [
    {
      "FieldId": "string",
      "DataFields": {
        "UserName": "string",
        "Employee": "string",
        "Title": "string",
        "GoalCategoryName": "string",
        "StartDate": null,
        "EndDate": null,
        "TargetMetric": "string",
        "TargetMetricUnit": "string",
        "Percentage": "string"
      }
    }
  ]
}

Goals

Properties

Name Type Required Restrictions Description
Status integer false none 0 -> Fail
1 -> Success
Summary Summary false none JSON Object of Summary
Data [GoalsData] false none JSON Array of Data Fields

GoalsData

{
  "FieldId": "string",
  "DataFields": {
    "UserName": "string",
    "Employee": "string",
    "Title": "string",
    "GoalCategoryName": "string",
    "StartDate": null,
    "EndDate": null,
    "TargetMetric": "string",
    "TargetMetricUnit": "string",
    "Percentage": "string"
  }
}

Goals Data

Properties

Name Type Required Restrictions Description
FieldId string false none none
DataFields GoalsDataFields false none JSON Object of Data Fields

GoalsDataFields

{
  "UserName": "string",
  "Employee": "string",
  "Title": "string",
  "GoalCategoryName": "string",
  "StartDate": null,
  "EndDate": null,
  "TargetMetric": "string",
  "TargetMetricUnit": "string",
  "Percentage": "string"
}

Goals Data Fields

Properties

Name Type Required Restrictions Description
UserName string false none none
Employee string false none none
Title string false none none
GoalCategoryName string false none none
StartDate date false none none
EndDate date false none none
TargetMetric string false none none
TargetMetricUnit string false none none
Percentage string false none none

GoalsAddProgress

{
  "FieldId": "string",
  "Data": {}
}

Add Progress

Properties

Name Type Required Restrictions Description
FieldId string false none none
Data object false none JSON Object of Data Fields

AddProgressData

{
  "ProgressDate": null,
  "Value": 0,
  "Comments": "string"
}

Add Progress Data

Properties

Name Type Required Restrictions Description
ProgressDate date false none none
Value integer false none none
Comments string false none none

EmployeesFormsList

{
  "Status": 1,
  "Summary": {
    "Page": 1,
    "RecordsPerPage": 10,
    "TotalRecords": 0,
    "Offset": 0,
    "NumberOfPages": 0,
    "Search": "string",
    "NextPageURL": "string"
  },
  "Data": [
    {
      "FieldId": "string",
      "DataFields": {
        "Employee": "string",
        "FormSubmissionStatus": "string",
        "SubmittedOn": null,
        "Deadline": null,
        "FormTitle": "string",
        "FormData": []
      }
    }
  ]
}

Employees Forms

Properties

Name Type Required Restrictions Description
Status integer false none 0 -> Fail
1 -> Success
Summary Summary false none JSON Object of Summary
Data [EmployeeFormsData] false none JSON Array of Data Fields

EmployeeFormsData

{
  "FieldId": "string",
  "DataFields": {
    "Employee": "string",
    "FormSubmissionStatus": "string",
    "SubmittedOn": null,
    "Deadline": null,
    "FormTitle": "string",
    "FormData": []
  }
}

Employee Forms Data

Properties

Name Type Required Restrictions Description
FieldId string false none none
DataFields EmployeeFormsDataFields false none JSON Object of Data Fields

EmployeeFormsDataFields

{
  "Employee": "string",
  "FormSubmissionStatus": "string",
  "SubmittedOn": null,
  "Deadline": null,
  "FormTitle": "string",
  "FormData": []
}

Employees Forms Data Fields

Properties

Name Type Required Restrictions Description
Employee string false none none
FormSubmissionStatus string false none none
SubmittedOn date false none none
Deadline date false none none
FormTitle string false none none
FormData array false none none

EmployeesFormTypesList

{
  "Status": 1,
  "Summary": {
    "Page": 1,
    "RecordsPerPage": 10,
    "TotalRecords": 0,
    "Offset": 0,
    "NumberOfPages": 0,
    "Search": "string",
    "NextPageURL": "string"
  },
  "Data": [
    {
      "FieldId": "string",
      "DataFields": {
        "FormTitle": "string",
        "AllowSelfFill": 0,
        "FormData": []
      }
    }
  ]
}

Employees Form Types

Properties

Name Type Required Restrictions Description
Status integer false none 0 -> Fail
1 -> Success
Summary Summary false none JSON Object of Summary
Data [EmployeeFormTypesData] false none JSON Array of Data Fields

EmployeeFormTypesData

{
  "FieldId": "string",
  "DataFields": {
    "FormTitle": "string",
    "AllowSelfFill": 0,
    "FormData": []
  }
}

Employee Forms Data

Properties

Name Type Required Restrictions Description
FieldId string false none none
DataFields EmployeeFormTypesDataFields false none JSON Object of Data Fields

EmployeeFormTypesDataFields

{
  "FormTitle": "string",
  "AllowSelfFill": 0,
  "FormData": []
}

Employees Forms Data Fields

Properties

Name Type Required Restrictions Description
FormTitle string false none none
AllowSelfFill integer false none none
FormData array false none none

EmployeeLeaveSalaryAndEOSReport

{
  "Period": "string",
  "SalaryDate": "string",
  "UserName": "string",
  "Department": "string",
  "Nationality": "string",
  "BasicSalary": "string",
  "Allowances": null,
  "PayrollItems": null,
  "LeavesSalaryAllowance": "string",
  "EndofServiceBenefitsAllowance": "string",
  "LeavesSalaryPaid": "string",
  "EndOfServicePaid": "string",
  "NetTotal": "string",
  "Currency": "string",
  "PhoneAllowance": "string",
  "FuelAllowance": "string"
}

Employee Leave Salary And EOS Report

Properties

Name Type Required Restrictions Description
Period string false none none
SalaryDate string false none none
UserName string false none none
Department string false none none
Nationality string false none none
BasicSalary string false none none
Allowances Array false none none
PayrollItems Array false none none
LeavesSalaryAllowance string false none none
EndofServiceBenefitsAllowance string false none none
LeavesSalaryPaid string false none none
EndOfServicePaid string false none none
NetTotal string false none none
Currency string false none none
PhoneAllowance string false none none
FuelAllowance string false none none

PayrollExtractionReport

{
  "Period": "string",
  "SalaryDate": "string",
  "UserName": "string",
  "Department": "string",
  "Nationality": "string",
  "BasicSalary": "string",
  "Allowances": "string",
  "PayrollItems": "string",
  "Commissions": "string",
  "Deductions": "string",
  "AitTicketAllowance": "string",
  "AdjustmentsChildStudy": "string",
  "AdjustmentsActingAllowance": "string",
  "EmployeeContribution": "string",
  "OrganizationContribution": "string",
  "LoanRepayments": "string",
  "NetTotal": "string",
  "PhoneAllowance": "string",
  "FuelAllowance": "string"
}

Payroll Extraction Report

Properties

Name Type Required Restrictions Description
Period string false none none
SalaryDate string false none none
UserName string false none none
Department string false none none
Nationality string false none none
BasicSalary string false none none
Allowances string false none none
PayrollItems string false none none
Commissions string false none none
Deductions string false none none
AitTicketAllowance string false none none
AdjustmentsChildStudy string false none none
AdjustmentsActingAllowance string false none none
EmployeeContribution string false none none
OrganizationContribution string false none none
LoanRepayments string false none none
NetTotal string false none none
PhoneAllowance string false none none
FuelAllowance string false none none

EmployeesParams

{
  "JoiningStartDate": null,
  "JoiningEndDate": null
}

Employees Params

Properties

Name Type Required Restrictions Description
JoiningStartDate date false none none
JoiningEndDate date false none none

TransferParams

{
  "StartDate": null,
  "EndDate": null
}

Transfer Params

Properties

Name Type Required Restrictions Description
StartDate date false none none
EndDate date false none none

ExitParams

{
  "StartDate": null,
  "EndDate": null,
  "AllowCustomFields": 0
}

Exit Params

Properties

Name Type Required Restrictions Description
StartDate date false none none
EndDate date false none none
AllowCustomFields integer false none none

EmployeeHoursParams

{
  "AllowCustomFields": 0
}

Employee Hours Params

Properties

Name Type Required Restrictions Description
AllowCustomFields integer false none none

AttendanceParams

{
  "UserName": "string",
  "StartDate": null,
  "EndDate": null
}

Suggestions

Properties

Name Type Required Restrictions Description
UserName string false none none
StartDate date false none none
EndDate date false none none

LeavesParams

{
  "UserName": "string",
  "StartDate": null,
  "EndDate": null,
  "ApprovalStatus": "string",
  "AllowCustomFields": 0
}

Leaves

Properties

Name Type Required Restrictions Description
UserName string false none none
StartDate date false none none
EndDate date false none none
ApprovalStatus string false none none
AllowCustomFields integer false none none

LeavesQuotaParams

{
  "Year": "string",
  "UserName": "string",
  "LeaveType": "string"
}

Leaves Quota

Properties

Name Type Required Restrictions Description
Year string false none none
UserName string false none none
LeaveType string false none none

PayslipParams

{
  "PayslipStartMonth": "string",
  "PayslipStartYear": "string",
  "PayslipEndMonth": "string",
  "PayslipEndYear": "string",
  "Company": "string",
  "Division": "string",
  "Station": "string",
  "DepartmentName": "string",
  "ShowLeaveSalary": 0,
  "ShowEndOfServiceBenefitAllowance": 0,
  "ShowLeaveSalaryPaid": 0,
  "ShowEndOfServicePaid": 0,
  "LeaveType": "string"
}

Payslip Params

Properties

Name Type Required Restrictions Description
PayslipStartMonth string false none none
PayslipStartYear string false none none
PayslipEndMonth string false none none
PayslipEndYear string false none none
Company string false none none
Division string false none none
Station string false none none
DepartmentName string false none none
ShowLeaveSalary integer false none none
ShowEndOfServiceBenefitAllowance integer false none none
ShowLeaveSalaryPaid integer false none none
ShowEndOfServicePaid integer false none none
LeaveType string false none none

AdvanceSalaryParams

{
  "StartDate": null,
  "EndDate": null
}

Advance Salary Params

Properties

Name Type Required Restrictions Description
StartDate date false none none
EndDate date false none none

ReimbursementsParams

{
  "UserName": "string",
  "StartDate": null,
  "EndDate": null
}

Reimbursements Params

Properties

Name Type Required Restrictions Description
UserName string false none none
StartDate date false none none
EndDate date false none none

JobPostParams

{
  "JobPostStatus": "string"
}

Job Posts Params

Properties

Name Type Required Restrictions Description
JobPostStatus string false none none

JobCandidatesParams

{
  "AppliedOn_StartDate": null,
  "AppliedOn_EndDate": null,
  "EmailAddress": "string",
  "AllowCustomFields": 0
}

Job Candidates Params

Properties

Name Type Required Restrictions Description
AppliedOn_StartDate date false none none
AppliedOn_EndDate date false none none
EmailAddress string false none none
AllowCustomFields integer false none none

JobCandidateFormsParams

{
  "JobCandidateEmailAddress": "string"
}

Job Candidate Forms Params

Properties

Name Type Required Restrictions Description
JobCandidateEmailAddress string false none none

EmployeesFormsParams

{
  "UserName": "string",
  "FormType": "string"
}

Employees Forms Params

Properties

Name Type Required Restrictions Description
UserName string false none none
FormType string false none none

EmployeesFormTypesParams

{
  "FormType": "string"
}

Employees Form Types Params

Properties

Name Type Required Restrictions Description
FormType string false none none

EmployeeLeaveSalaryAndEOSReportParams

{
  "StartMonth": "string",
  "StartYear": "string",
  "EndMonth": "string",
  "EndYear": "string",
  "PayrollSetup": "string",
  "LeaveType": "string"
}

Employee Leave Salary And EOS Report Params

Properties

Name Type Required Restrictions Description
StartMonth string false none none
StartYear string false none none
EndMonth string false none none
EndYear string false none none
PayrollSetup string false none none
LeaveType string false none none

PayrollExtractionReportParams

{
  "StartMonth": "string",
  "StartYear": "string",
  "EndMonth": "string",
  "EndYear": "string",
  "PayrollSetup": "string"
}

Payroll Extraction Report

Properties

Name Type Required Restrictions Description
StartMonth string false none none
StartYear string false none none
EndMonth string false none none
EndYear string false none none
PayrollSetup string false none none

Summary

{
  "Page": 1,
  "RecordsPerPage": 10,
  "TotalRecords": 0,
  "Offset": 0,
  "NumberOfPages": 0,
  "Search": "string",
  "NextPageURL": "string"
}

Summary

Properties

Name Type Required Restrictions Description
Page integer false none none
RecordsPerPage integer false none none
TotalRecords integer false none none
Offset integer false none none
NumberOfPages integer false none none
Search string false none none
NextPageURL string false none none
Shell HTTP JavaScript Ruby Python PHP Java Go