Add Employee Salary

Add Employee Salary

Purpose

To add new payroll/location to your organization.

Request URL

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

Request Method

POST
Note
  • Send authkey in https header
  • You can add only one payroll per POST request.
  • 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 inserted payroll data in JSON format or error message.

Request JSON

Attribute Data Type Mandatory Description
payrollname text yes payroll/location/company name
currency text
country text
timezone text
city text
companyphone text
contactperson text

Sample Request

curl --location --request POST 'https://live.membroz.com/api/payrolls' \
--header 'authkey: XXXXXXXXXX' \
--header 'Content-Type: application/json' \
--data-raw ' {
        "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": [
                        {
                            "_id": "5f1a84fd36c0508498b66ed7",
                            "deviceid": "868134036807517",
                            "registrationid": "dXrgg6gpD8A:APA91bH8HZLfCO9qw0UsA-QK5IOlcMPvHJlDG4ZCbj65gAs6GMD3-OGuqEMBQfxU85VhaK6V5k4g-bnZJexeiJN3Zot4jnFi8y1_qpGwqlCb2-iczXGzZD0dOjH0c3S7FywyxO243_6f"
                        }
                    ],
                    "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
            }
        ],
        "branchid":  "5e954c7b9df11624f81e7859",
        "addedby": "5e954c7b9df11624f81e785b",
        "createdAt": "2020-09-28T13:31:21.796Z",
        "updatedAt": "2020-09-28T13:31:21.796Z",
        "updatedby": "5e954c7b9df11624f81e785b"
    }'
OkHttpClient client = new OkHttpClient().newBuilder()
  .build();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, " {\r\n        \"status\": \"active\",\r\n        \"month\": \"9\",\r\n        \"year\": 2020,\r\n        \"employeesalary\": [\r\n            {\r\n                \"salarycomponent\": [],\r\n                \"_id\": \"5f71e5a9aa8a650ac03388b6\",\r\n                \"employeeid\": {\r\n                    \"_id\": \"5f198c3b476f6965d5d06d02\",\r\n                    \"isfirstlogin\": false,\r\n                    \"status\": \"active\",\r\n                    \"username\": \"abhinavaps@gmail.com\",\r\n                    \"password\": \"$2a$10$xE/CIr/hKCKvBaaJwUlZHuV7MFi2Ao.9jwh0RAYpAEfgr3dCfNABq\",\r\n                    \"role\": \"5dd7e21e80199f0aecd400ab\",\r\n                    \"anroiddevices\": [\r\n                        {\r\n                            \"_id\": \"5f1a84fd36c0508498b66ed7\",\r\n                            \"deviceid\": \"868134036807517\",\r\n                            \"registrationid\": \"dXrgg6gpD8A:APA91bH8HZLfCO9qw0UsA-QK5IOlcMPvHJlDG4ZCbj65gAs6GMD3-OGuqEMBQfxU85VhaK6V5k4g-bnZJexeiJN3Zot4jnFi8y1_qpGwqlCb2-iczXGzZD0dOjH0c3S7FywyxO243_6f\"\r\n                        }\r\n                    ],\r\n                    \"iosdevices\": [],\r\n                    \"designationid\": \"5c9a0e1112b3f913dc5ab3ba\",\r\n                    \"branchid\": \"5f198c3b476f6965d5d06d00\",\r\n                    \"property\": {\r\n                        \"fullname\": \"Abhinav \",\r\n                        \"mobile_number\": \"9015022288\",\r\n                        \"email\": \"abhinavaps@gmail.com\",\r\n                        \"country\": \"India\",\r\n                        \"membrozid\": \"5f198c3b476f6965d5d06d00\",\r\n                        \"isadmin\": false\r\n                    },\r\n                    \"createdAt\": \"2020-07-23T13:10:19.942Z\",\r\n                    \"updatedAt\": \"2020-07-24T06:51:41.488Z\",\r\n                    \"fullname\": \"Abhinav  \",\r\n                    \"namenumber\": \"Abhinav   | 9015022288\"\r\n                },\r\n                \"holidays\": 0,\r\n                \"cf\": 0,\r\n                \"workingdays\": 0,\r\n                \"attendance\": 0,\r\n                \"absent\": 0,\r\n                \"paidleave\": 0,\r\n                \"paidleaveamount\": 0,\r\n                \"taxableamount\": 0,\r\n                \"taxamount\": 0,\r\n                \"salarypaid\": 0\r\n            }\r\n        ],\r\n        \"branchid\":  \"5e954c7b9df11624f81e7859\",\r\n        \"addedby\": \"5e954c7b9df11624f81e785b\",\r\n        \"createdAt\": \"2020-09-28T13:31:21.796Z\",\r\n        \"updatedAt\": \"2020-09-28T13:31:21.796Z\",\r\n        \"updatedby\": \"5e954c7b9df11624f81e785b\"\r\n    }");
Request request = new Request.Builder()
  .url("https://live.membroz.com/api/payrolls")
  .method("POST", body)
  .addHeader("authkey", "XXXXXXXXXX")
  .addHeader("Content-Type", "application/json")
  .build();
Response response = client.newCall(request).execute();
 "https://live.membroz.com/api/payrolls",
  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        \"status\": \"active\",\r\n        \"month\": \"9\",\r\n        \"year\": 2020,\r\n        \"employeesalary\": [\r\n            {\r\n                \"salarycomponent\": [],\r\n                \"_id\": \"5f71e5a9aa8a650ac03388b6\",\r\n                \"employeeid\": {\r\n                    \"_id\": \"5f198c3b476f6965d5d06d02\",\r\n                    \"isfirstlogin\": false,\r\n                    \"status\": \"active\",\r\n                    \"username\": \"abhinavaps@gmail.com\",\r\n                    \"password\": \"$2a$10$xE/CIr/hKCKvBaaJwUlZHuV7MFi2Ao.9jwh0RAYpAEfgr3dCfNABq\",\r\n                    \"role\": \"5dd7e21e80199f0aecd400ab\",\r\n                    \"anroiddevices\": [\r\n                        {\r\n                            \"_id\": \"5f1a84fd36c0508498b66ed7\",\r\n                            \"deviceid\": \"868134036807517\",\r\n                            \"registrationid\": \"dXrgg6gpD8A:APA91bH8HZLfCO9qw0UsA-QK5IOlcMPvHJlDG4ZCbj65gAs6GMD3-OGuqEMBQfxU85VhaK6V5k4g-bnZJexeiJN3Zot4jnFi8y1_qpGwqlCb2-iczXGzZD0dOjH0c3S7FywyxO243_6f\"\r\n                        }\r\n                    ],\r\n                    \"iosdevices\": [],\r\n                    \"designationid\": \"5c9a0e1112b3f913dc5ab3ba\",\r\n                    \"branchid\": \"5f198c3b476f6965d5d06d00\",\r\n                    \"property\": {\r\n                        \"fullname\": \"Abhinav \",\r\n                        \"mobile_number\": \"9015022288\",\r\n                        \"email\": \"abhinavaps@gmail.com\",\r\n                        \"country\": \"India\",\r\n                        \"membrozid\": \"5f198c3b476f6965d5d06d00\",\r\n                        \"isadmin\": false\r\n                    },\r\n                    \"createdAt\": \"2020-07-23T13:10:19.942Z\",\r\n                    \"updatedAt\": \"2020-07-24T06:51:41.488Z\",\r\n                    \"fullname\": \"Abhinav  \",\r\n                    \"namenumber\": \"Abhinav   | 9015022288\"\r\n                },\r\n                \"holidays\": 0,\r\n                \"cf\": 0,\r\n                \"workingdays\": 0,\r\n                \"attendance\": 0,\r\n                \"absent\": 0,\r\n                \"paidleave\": 0,\r\n                \"paidleaveamount\": 0,\r\n                \"taxableamount\": 0,\r\n                \"taxamount\": 0,\r\n                \"salarypaid\": 0\r\n            }\r\n        ],\r\n        \"branchid\":  \"5e954c7b9df11624f81e7859\",\r\n        \"addedby\": \"5e954c7b9df11624f81e785b\",\r\n        \"createdAt\": \"2020-09-28T13:31:21.796Z\",\r\n        \"updatedAt\": \"2020-09-28T13:31:21.796Z\",\r\n        \"updatedby\": \"5e954c7b9df11624f81e785b\"\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"

payload = " {\r\n        \"status\": \"active\",\r\n        \"month\": \"9\",\r\n        \"year\": 2020,\r\n        \"employeesalary\": [\r\n            {\r\n                \"salarycomponent\": [],\r\n                \"_id\": \"5f71e5a9aa8a650ac03388b6\",\r\n                \"employeeid\": {\r\n                    \"_id\": \"5f198c3b476f6965d5d06d02\",\r\n                    \"isfirstlogin\": false,\r\n                    \"status\": \"active\",\r\n                    \"username\": \"abhinavaps@gmail.com\",\r\n                    \"password\": \"$2a$10$xE/CIr/hKCKvBaaJwUlZHuV7MFi2Ao.9jwh0RAYpAEfgr3dCfNABq\",\r\n                    \"role\": \"5dd7e21e80199f0aecd400ab\",\r\n                    \"anroiddevices\": [\r\n                        {\r\n                            \"_id\": \"5f1a84fd36c0508498b66ed7\",\r\n                            \"deviceid\": \"868134036807517\",\r\n                            \"registrationid\": \"dXrgg6gpD8A:APA91bH8HZLfCO9qw0UsA-QK5IOlcMPvHJlDG4ZCbj65gAs6GMD3-OGuqEMBQfxU85VhaK6V5k4g-bnZJexeiJN3Zot4jnFi8y1_qpGwqlCb2-iczXGzZD0dOjH0c3S7FywyxO243_6f\"\r\n                        }\r\n                    ],\r\n                    \"iosdevices\": [],\r\n                    \"designationid\": \"5c9a0e1112b3f913dc5ab3ba\",\r\n                    \"branchid\": \"5f198c3b476f6965d5d06d00\",\r\n                    \"property\": {\r\n                        \"fullname\": \"Abhinav \",\r\n                        \"mobile_number\": \"9015022288\",\r\n                        \"email\": \"abhinavaps@gmail.com\",\r\n                        \"country\": \"India\",\r\n                        \"membrozid\": \"5f198c3b476f6965d5d06d00\",\r\n                        \"isadmin\": false\r\n                    },\r\n                    \"createdAt\": \"2020-07-23T13:10:19.942Z\",\r\n                    \"updatedAt\": \"2020-07-24T06:51:41.488Z\",\r\n                    \"fullname\": \"Abhinav  \",\r\n                    \"namenumber\": \"Abhinav   | 9015022288\"\r\n                },\r\n                \"holidays\": 0,\r\n                \"cf\": 0,\r\n                \"workingdays\": 0,\r\n                \"attendance\": 0,\r\n                \"absent\": 0,\r\n                \"paidleave\": 0,\r\n                \"paidleaveamount\": 0,\r\n                \"taxableamount\": 0,\r\n                \"taxamount\": 0,\r\n                \"salarypaid\": 0\r\n            }\r\n        ],\r\n        \"branchid\":  \"5e954c7b9df11624f81e7859\",\r\n        \"addedby\": \"5e954c7b9df11624f81e785b\",\r\n        \"createdAt\": \"2020-09-28T13:31:21.796Z\",\r\n        \"updatedAt\": \"2020-09-28T13:31:21.796Z\",\r\n        \"updatedby\": \"5e954c7b9df11624f81e785b\"\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")

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

response = https.request(request)
puts response.read_body
var client = new RestClient("https://live.membroz.com/api/payrolls");
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        \"status\": \"active\",\r\n        \"month\": \"9\",\r\n        \"year\": 2020,\r\n        \"employeesalary\": [\r\n            {\r\n                \"salarycomponent\": [],\r\n                \"_id\": \"5f71e5a9aa8a650ac03388b6\",\r\n                \"employeeid\": {\r\n                    \"_id\": \"5f198c3b476f6965d5d06d02\",\r\n                    \"isfirstlogin\": false,\r\n                    \"status\": \"active\",\r\n                    \"username\": \"abhinavaps@gmail.com\",\r\n                    \"password\": \"$2a$10$xE/CIr/hKCKvBaaJwUlZHuV7MFi2Ao.9jwh0RAYpAEfgr3dCfNABq\",\r\n                    \"role\": \"5dd7e21e80199f0aecd400ab\",\r\n                    \"anroiddevices\": [\r\n                        {\r\n                            \"_id\": \"5f1a84fd36c0508498b66ed7\",\r\n                            \"deviceid\": \"868134036807517\",\r\n                            \"registrationid\": \"dXrgg6gpD8A:APA91bH8HZLfCO9qw0UsA-QK5IOlcMPvHJlDG4ZCbj65gAs6GMD3-OGuqEMBQfxU85VhaK6V5k4g-bnZJexeiJN3Zot4jnFi8y1_qpGwqlCb2-iczXGzZD0dOjH0c3S7FywyxO243_6f\"\r\n                        }\r\n                    ],\r\n                    \"iosdevices\": [],\r\n                    \"designationid\": \"5c9a0e1112b3f913dc5ab3ba\",\r\n                    \"branchid\": \"5f198c3b476f6965d5d06d00\",\r\n                    \"property\": {\r\n                        \"fullname\": \"Abhinav \",\r\n                        \"mobile_number\": \"9015022288\",\r\n                        \"email\": \"abhinavaps@gmail.com\",\r\n                        \"country\": \"India\",\r\n                        \"membrozid\": \"5f198c3b476f6965d5d06d00\",\r\n                        \"isadmin\": false\r\n                    },\r\n                    \"createdAt\": \"2020-07-23T13:10:19.942Z\",\r\n                    \"updatedAt\": \"2020-07-24T06:51:41.488Z\",\r\n                    \"fullname\": \"Abhinav  \",\r\n                    \"namenumber\": \"Abhinav   | 9015022288\"\r\n                },\r\n                \"holidays\": 0,\r\n                \"cf\": 0,\r\n                \"workingdays\": 0,\r\n                \"attendance\": 0,\r\n                \"absent\": 0,\r\n                \"paidleave\": 0,\r\n                \"paidleaveamount\": 0,\r\n                \"taxableamount\": 0,\r\n                \"taxamount\": 0,\r\n                \"salarypaid\": 0\r\n            }\r\n        ],\r\n        \"branchid\":  \"5e954c7b9df11624f81e7859\",\r\n        \"addedby\": \"5e954c7b9df11624f81e785b\",\r\n        \"createdAt\": \"2020-09-28T13:31:21.796Z\",\r\n        \"updatedAt\": \"2020-09-28T13:31:21.796Z\",\r\n        \"updatedby\": \"5e954c7b9df11624f81e785b\"\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

{
    "status": "active",
    "_id": "5f74460dd698d643837e2da4",
    "month": "9",
    "year": 2020,
    "employeesalary": [
        {
            "salarycomponent": [],
            "_id": "5f71e5a9aa8a650ac03388b6",
            "employeeid": "5f198c3b476f6965d5d06d02",
            "holidays": 0,
            "cf": 0,
            "workingdays": 0,
            "attendance": 0,
            "absent": 0,
            "paidleave": 0,
            "paidleaveamount": 0,
            "taxableamount": 0,
            "taxamount": 0,
            "salarypaid": 0
        }
    ],
    "branchid": "5e954c7b9df11624f81e7859",
    "addedby": "5e954c7b9df11624f81e785b",
    "createdAt": "2020-09-30T08:47:09.456Z",
    "updatedAt": "2020-09-30T08:47:09.456Z",
    "updatedby": "5e954c7b9df11624f81e785b"
}