Update Employee Salary

Update Employee Salary

Purpose

To update the payroll/location detail of your organization.

Request URL

https://live.membroz.com/api/payrolls/[payrollid]

Request Method

PUT
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 return updated payroll data in json format or return error message.

Request JSON

Attribute Data Type Mandatory Description
PAYROLLID String Yes The record ID of the payroll you want to update. it is pass in request
/api/payrolls/[payrollid]

Sample Request

curl --location --request PUT 'https://live.membroz.com/api/payrolls/[payrollid]'\
--header 'authkey: XXXXXXXXXX' \
--header 'Content-Type: application/json' \
--data-raw '{
    "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"
}'
OkHttpClient client = new OkHttpClient().newBuilder()
  .build();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\r\n    \"status\": \"active\",\r\n    \"_id\": \"5f74460dd698d643837e2da4\",\r\n    \"month\": \"9\",\r\n    \"year\": 2020,\r\n    \"employeesalary\": [\r\n        {\r\n            \"salarycomponent\": [],\r\n            \"_id\": \"5f71e5a9aa8a650ac03388b6\",\r\n            \"employeeid\": \"5f198c3b476f6965d5d06d02\",\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-30T08:47:09.456Z\",\r\n    \"updatedAt\": \"2020-09-30T08:47:09.456Z\",\r\n    \"updatedby\": \"5e954c7b9df11624f81e785b\"\r\n}");
Request request = new Request.Builder()
  .url("https://live.membroz.com/api/payrolls/[payrollid]")
  .method("PUT", body)
  .addHeader("authkey", "XXXXXXXXXX")
  .addHeader("Content-Type", "application/json")
  .build();
Response response = client.newCall(request).execute();
 "https://live.membroz.com/api/payrolls/[payrollid]",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS =>"{\r\n    \"status\": \"active\",\r\n    \"_id\": \"5f74460dd698d643837e2da4\",\r\n    \"month\": \"9\",\r\n    \"year\": 2020,\r\n    \"employeesalary\": [\r\n        {\r\n            \"salarycomponent\": [],\r\n            \"_id\": \"5f71e5a9aa8a650ac03388b6\",\r\n            \"employeeid\": \"5f198c3b476f6965d5d06d02\",\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-30T08:47:09.456Z\",\r\n    \"updatedAt\": \"2020-09-30T08:47:09.456Z\",\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/[payrollid]"

payload = "{\r\n    \"status\": \"active\",\r\n    \"_id\": \"5f74460dd698d643837e2da4\",\r\n    \"month\": \"9\",\r\n    \"year\": 2020,\r\n    \"employeesalary\": [\r\n        {\r\n            \"salarycomponent\": [],\r\n            \"_id\": \"5f71e5a9aa8a650ac03388b6\",\r\n            \"employeeid\": \"5f198c3b476f6965d5d06d02\",\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-30T08:47:09.456Z\",\r\n    \"updatedAt\": \"2020-09-30T08:47:09.456Z\",\r\n    \"updatedby\": \"5e954c7b9df11624f81e785b\"\r\n}"
headers = {
  'authkey': 'XXXXXXXXXX',
  'Content-Type': 'application/json'
}

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

print(response.text.encode('utf8'))
require "uri"
require "net/http"

url = URI("https://live.membroz.com/api/payrolls/[payrollid]")

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

request = Net::HTTP::Put.new(url)
request["authkey"] = "XXXXXXXXXX"
request["Content-Type"] = "application/json"
request.body = "{\r\n    \"status\": \"active\",\r\n    \"_id\": \"5f74460dd698d643837e2da4\",\r\n    \"month\": \"9\",\r\n    \"year\": 2020,\r\n    \"employeesalary\": [\r\n        {\r\n            \"salarycomponent\": [],\r\n            \"_id\": \"5f71e5a9aa8a650ac03388b6\",\r\n            \"employeeid\": \"5f198c3b476f6965d5d06d02\",\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-30T08:47:09.456Z\",\r\n    \"updatedAt\": \"2020-09-30T08:47:09.456Z\",\r\n    \"updatedby\": \"5e954c7b9df11624f81e785b\"\r\n}"

response = https.request(request)
puts response.read_body
var client = new RestClient("https://live.membroz.com/api/payrolls/[payrollid]");
client.Timeout = -1;
var request = new RestRequest(Method.PUT);
request.AddHeader("authkey", "XXXXXXXXXX");
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{\r\n    \"status\": \"active\",\r\n    \"_id\": \"5f74460dd698d643837e2da4\",\r\n    \"month\": \"9\",\r\n    \"year\": 2020,\r\n    \"employeesalary\": [\r\n        {\r\n            \"salarycomponent\": [],\r\n            \"_id\": \"5f71e5a9aa8a650ac03388b6\",\r\n            \"employeeid\": \"5f198c3b476f6965d5d06d02\",\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-30T08:47:09.456Z\",\r\n    \"updatedAt\": \"2020-09-30T08:47:09.456Z\",\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": "5f71e5a9aa8a650ac03388b5",
    "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-28T13:31:21.796Z",
    "updatedAt": "2020-09-30T08:48:32.456Z",
    "updatedby": "5e954c7b9df11624f81e785b"
}
Send Message
Hello!
How can we help!