Get Employee Salary

Get Employee Salary

Purpose

To get the payroll/Location of your Organization.

Payroll API accept post request with filter conditions. Response include filter payrolls array with matching conditions.

API return JSON array of payroll.

Request URL

https://live.membroz.com/api/payrolls/filter

Request Method

POST
Note
  • Send authkey in https header
  • You must use only Field API names in the input. You can obtain the field API names from Fields metadata API
  • Enterprise customer can replace domain name with their hosting Url. for example https://app.xyz.com/api/payrolls
  • API will return matching records in array or error message.

Request JSON

Attribute Data Type Mandatory Description
search Array yes Add search fields to filter out return data.
Example: { "search":[{ "searchfield": "status", "searchvalue": "active", "criteria": "eq", "datattype": "text" }]}
Only status = "active" records will return
select Array Add select fields to restrict return data schema.
Example: Example: { "fieldname": "branchname", "value": 1 }
Only branchname will return
sort object Sort return array based on sort input
Example: { "branchname" : 1}
limit number limit return array size
Example: limit: 10
only 10 records will return in the array

Sample Request

curl --location --request POST 'https://live.membroz.com/api/payrolls/filter' \
--header 'authkey: XXXXXXXXXX' \
--header 'Content-Type: application/json' \
--data-raw '{ 
    "search": [
        { "searchfield": "status", "searchvalue": "active", "criteria": "eq", "datatype": "text" }
    ]
}
'
OkHttpClient client = new OkHttpClient().newBuilder()
  .build();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{ \r\n    \"search\": [\r\n        { \"searchfield\": \"status\", \"searchvalue\": \"active\", \"criteria\": \"eq\", \"datatype\": \"text\" }\r\n    ]\r\n}\r\n");
Request request = new Request.Builder()
  .url("https://live.membroz.com/api/payrolls/filter")
  .method("POST", body)
  .addHeader("authkey", "XXXXXXXXXX")
  .addHeader("Content-Type", "application/json")
  .build();
Response response = client.newCall(request).execute();
 "https://live.membroz.com/api/payrolls/filter",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS =>"{ \r\n    \"search\": [\r\n        { \"searchfield\": \"status\", \"searchvalue\": \"active\", \"criteria\": \"eq\", \"datatype\": \"text\" }\r\n    ]\r\n}\r\n",
  CURLOPT_HTTPHEADER => array(
    "authkey: XXXXXXXXXX",
    "Content-Type: application/json"
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

import requests

url = "https://live.membroz.com/api/payrolls/filter"

payload = "{ \r\n    \"search\": [\r\n        { \"searchfield\": \"status\", \"searchvalue\": \"active\", \"criteria\": \"eq\", \"datatype\": \"text\" }\r\n    ]\r\n}\r\n"
headers = {
  'authkey': 'XXXXXXXXXX',
  'Content-Type': 'application/json'
}

response = requests.request("POST", url, headers=headers, data = payload)

print(response.text.encode('utf8'))

require "uri"
require "net/http"

url = URI("https://live.membroz.com/api/payrolls/filter")

https = Net::HTTP.new(url.host, url.port);
https.use_ssl = true

request = Net::HTTP::Post.new(url)
request["authkey"] = "XXXXXXXXXX"
request["Content-Type"] = "application/json"
request.body = "{ \r\n    \"search\": [\r\n        { \"searchfield\": \"status\", \"searchvalue\": \"active\", \"criteria\": \"eq\", \"datatype\": \"text\" }\r\n    ]\r\n}\r\n"

response = https.request(request)
puts response.read_body

var client = new RestClient("https://live.membroz.com/api/payrolls/filter");
client.Timeout = -1;
var request = new RestRequest(Method.POST);
request.AddHeader("authkey", "XXXXXXXXXX");
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{ \r\n    \"search\": [\r\n        { \"searchfield\": \"status\", \"searchvalue\": \"active\", \"criteria\": \"eq\", \"datatype\": \"text\" }\r\n    ]\r\n}\r\n",  ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
Console.WriteLine(response.Content);

Possible Errors

HTTP Status Error Code Message Reason
permission denied 403 You do not have permission

Sample Response

{
        "_id": "5f71e5a9aa8a650ac03388b5",
        "status": "active",
        "month": "9",
        "year": 2020,
        "employeesalary": [
            {
                "salarycomponent": [],
                "_id": "5f71e5a9aa8a650ac03388b6",
                "employeeid": {
                    "_id": "5f198c3b476f6965d5d06d02",
                    "isfirstlogin": false,
                    "status": "active",
                    "username": "abhinavaps@gmail.com",
                    "password": "$2a$10$xE/CIr/hKCKvBaaJwUlZHuV7MFi2Ao.9jwh0RAYpAEfgr3dCfNABq",
                    "role": "5dd7e21e80199f0aecd400ab",
                    "anroiddevices": "5f1a84fd36c0508498b66ed7",
                    "iosdevices": [],
                    "designationid": "5c9a0e1112b3f913dc5ab3ba",
                    "branchid": "5f198c3b476f6965d5d06d00",
                    "property": {
                        "fullname": "Abhinav ",
                        "mobile_number": "9015022288",
                        "email": "abhinavaps@gmail.com",
                        "country": "India",
                        "membrozid": "5f198c3b476f6965d5d06d00",
                        "isadmin": false
                    },
                    "createdAt": "2020-07-23T13:10:19.942Z",
                    "updatedAt": "2020-07-24T06:51:41.488Z",
                    "fullname": "Abhinav  ",
                    "namenumber": "Abhinav   | 9015022288"
                },
                "holidays": 0,
                "cf": 0,
                "workingdays": 0,
                "attendance": 0,
                "absent": 0,
                "paidleave": 0,
                "paidleaveamount": 0,
                "taxableamount": 0,
                "taxamount": 0,
                "salarypaid": 0
            },
            ]
        "addedby": "5e954c7b9df11624f81e785b",
        "createdAt": "2020-09-28T13:31:21.796Z",
        "updatedAt": "2020-09-28T13:31:21.796Z",
        "updatedby": "5e954c7b9df11624f81e785b"
    }