Add Salary Component

Add Salary Component

Purpose

To add new salarycomponent/location to your organization.

Request URL

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

Request Method

POST
Note
  • Send authkey in https header
  • You can add only one salarycomponents 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/salarycomponents
  • API will return inserted salarycomponent data in JSON format or error message.

Request JSON

Attribute Data Type Mandatory Description
salarycomponentname text yes salarycomponent/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/salarycomponents' \
--header 'authkey: XXXXXXXXXX' \
--header 'Content-Type: application/json' \
--data-raw '  {
       
        "type": "statutory",
        "percentageofsalarycomponent": [],
        "monthly_gross_salary": [
            {
                "id": "b4ae9bb2-9b10-4a43-bcc4-f333aae7c180",
                "index": 1,
                "start_range": 1,
                "end_range": 2999,
                "monthly_tax_amount": 0
            },
            {
                "id": "ca7464e6-73f3-4d66-98a2-c257212c2471",
                "index": 2,
                "start_range": 3000,
                "end_range": 5999,
                "monthly_tax_amount": 0
            },
            {
                "id": "010f02bd-3fcd-44a7-9218-793bdb622c69",
                "index": 3,
                "start_range": 6000,
                "end_range": 9999,
                "monthly_tax_amount": 100
            }
        ],
        "status": "active",
        "title": "Professional Tax",
        "calculationtype": "amount",
        "isdefault": true,
        "branchid": "5e954c7b9df11624f81e7859",
        "is_ctc": false,
        "number": "1212121212",
        "deduction_cycle": "monthly",
        "employer_contribution_rate": "3.25",
        "employee_contribution_rate": "0.75",
        "include_employers_contribution_ctc": true,
        "pro_rate_restricted_pf_wages": true,
        "createdAt": "2020-09-04T11:48:28.167Z",
        "updatedAt": "2020-09-29T10:22:49.455Z",
        "is_system": false
    }'
OkHttpClient client = new OkHttpClient().newBuilder()
  .build();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "  {\r\n       \r\n        \"type\": \"statutory\",\r\n        \"percentageofsalarycomponent\": [],\r\n        \"monthly_gross_salary\": [\r\n            {\r\n                \"id\": \"b4ae9bb2-9b10-4a43-bcc4-f333aae7c180\",\r\n                \"index\": 1,\r\n                \"start_range\": 1,\r\n                \"end_range\": 2999,\r\n                \"monthly_tax_amount\": 0\r\n            },\r\n            {\r\n                \"id\": \"ca7464e6-73f3-4d66-98a2-c257212c2471\",\r\n                \"index\": 2,\r\n                \"start_range\": 3000,\r\n                \"end_range\": 5999,\r\n                \"monthly_tax_amount\": 0\r\n            },\r\n            {\r\n                \"id\": \"010f02bd-3fcd-44a7-9218-793bdb622c69\",\r\n                \"index\": 3,\r\n                \"start_range\": 6000,\r\n                \"end_range\": 9999,\r\n                \"monthly_tax_amount\": 100\r\n            },\r\n            {\r\n                \"id\": \"7e66c7b8-1f50-4b39-a60d-bb2ab9f96b52\",\r\n                \"index\": 4,\r\n                \"start_range\": 10000,\r\n                \"end_range\": 11999,\r\n                \"monthly_tax_amount\": 200\r\n            },\r\n            {\r\n                \"id\": \"71d335bb-ff3f-4425-b698-d63982f16154\",\r\n                \"index\": 5,\r\n                \"start_range\": 12000,\r\n                \"end_range\": 999999999,\r\n                \"monthly_tax_amount\": 200\r\n            },\r\n            {\r\n                \"id\": \"71d335bb-ff3f-4425-b698-d63982f16154\",\r\n                \"index\": 6,\r\n                \"start_range\": 12000,\r\n                \"end_range\": 999999999,\r\n                \"monthly_tax_amount\": 200\r\n            }\r\n        ],\r\n        \"status\": \"active\",\r\n        \"title\": \"Professional Tax\",\r\n        \"calculationtype\": \"amount\",\r\n        \"isdefault\": true,\r\n        \"branchid\": \"5e954c7b9df11624f81e7859\",\r\n        \"is_ctc\": false,\r\n        \"number\": \"1212121212\",\r\n        \"deduction_cycle\": \"monthly\",\r\n        \"employer_contribution_rate\": \"3.25\",\r\n        \"employee_contribution_rate\": \"0.75\",\r\n        \"include_employers_contribution_ctc\": true,\r\n        \"pro_rate_restricted_pf_wages\": true,\r\n        \"createdAt\": \"2020-09-04T11:48:28.167Z\",\r\n        \"updatedAt\": \"2020-09-29T10:22:49.455Z\",\r\n        \"is_system\": false\r\n    }");
Request request = new Request.Builder()
  .url("https://live.membroz.com/api/salarycomponents")
  .method("POST", body)
  .addHeader("authkey", "XXXXXXXXXX")
  .addHeader("Content-Type", "application/json")
  .build();
Response response = client.newCall(request).execute();
 "https://live.membroz.com/api/salarycomponents",
  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       \r\n        \"type\": \"statutory\",\r\n        \"percentageofsalarycomponent\": [],\r\n        \"monthly_gross_salary\": [\r\n            {\r\n                \"id\": \"b4ae9bb2-9b10-4a43-bcc4-f333aae7c180\",\r\n                \"index\": 1,\r\n                \"start_range\": 1,\r\n                \"end_range\": 2999,\r\n                \"monthly_tax_amount\": 0\r\n            },\r\n            {\r\n                \"id\": \"ca7464e6-73f3-4d66-98a2-c257212c2471\",\r\n                \"index\": 2,\r\n                \"start_range\": 3000,\r\n                \"end_range\": 5999,\r\n                \"monthly_tax_amount\": 0\r\n            },\r\n            {\r\n                \"id\": \"010f02bd-3fcd-44a7-9218-793bdb622c69\",\r\n                \"index\": 3,\r\n                \"start_range\": 6000,\r\n                \"end_range\": 9999,\r\n                \"monthly_tax_amount\": 100\r\n            },\r\n            {\r\n                \"id\": \"7e66c7b8-1f50-4b39-a60d-bb2ab9f96b52\",\r\n                \"index\": 4,\r\n                \"start_range\": 10000,\r\n                \"end_range\": 11999,\r\n                \"monthly_tax_amount\": 200\r\n            },\r\n            {\r\n                \"id\": \"71d335bb-ff3f-4425-b698-d63982f16154\",\r\n                \"index\": 5,\r\n                \"start_range\": 12000,\r\n                \"end_range\": 999999999,\r\n                \"monthly_tax_amount\": 200\r\n            },\r\n            {\r\n                \"id\": \"71d335bb-ff3f-4425-b698-d63982f16154\",\r\n                \"index\": 6,\r\n                \"start_range\": 12000,\r\n                \"end_range\": 999999999,\r\n                \"monthly_tax_amount\": 200\r\n            }\r\n        ],\r\n        \"status\": \"active\",\r\n        \"title\": \"Professional Tax\",\r\n        \"calculationtype\": \"amount\",\r\n        \"isdefault\": true,\r\n        \"branchid\": \"5e954c7b9df11624f81e7859\",\r\n        \"is_ctc\": false,\r\n        \"number\": \"1212121212\",\r\n        \"deduction_cycle\": \"monthly\",\r\n        \"employer_contribution_rate\": \"3.25\",\r\n        \"employee_contribution_rate\": \"0.75\",\r\n        \"include_employers_contribution_ctc\": true,\r\n        \"pro_rate_restricted_pf_wages\": true,\r\n        \"createdAt\": \"2020-09-04T11:48:28.167Z\",\r\n        \"updatedAt\": \"2020-09-29T10:22:49.455Z\",\r\n        \"is_system\": false\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/salarycomponents"

payload = "  {\r\n       \r\n        \"type\": \"statutory\",\r\n        \"percentageofsalarycomponent\": [],\r\n        \"monthly_gross_salary\": [\r\n            {\r\n                \"id\": \"b4ae9bb2-9b10-4a43-bcc4-f333aae7c180\",\r\n                \"index\": 1,\r\n                \"start_range\": 1,\r\n                \"end_range\": 2999,\r\n                \"monthly_tax_amount\": 0\r\n            },\r\n            {\r\n                \"id\": \"ca7464e6-73f3-4d66-98a2-c257212c2471\",\r\n                \"index\": 2,\r\n                \"start_range\": 3000,\r\n                \"end_range\": 5999,\r\n                \"monthly_tax_amount\": 0\r\n            },\r\n            {\r\n                \"id\": \"010f02bd-3fcd-44a7-9218-793bdb622c69\",\r\n                \"index\": 3,\r\n                \"start_range\": 6000,\r\n                \"end_range\": 9999,\r\n                \"monthly_tax_amount\": 100\r\n            },\r\n            {\r\n                \"id\": \"7e66c7b8-1f50-4b39-a60d-bb2ab9f96b52\",\r\n                \"index\": 4,\r\n                \"start_range\": 10000,\r\n                \"end_range\": 11999,\r\n                \"monthly_tax_amount\": 200\r\n            },\r\n            {\r\n                \"id\": \"71d335bb-ff3f-4425-b698-d63982f16154\",\r\n                \"index\": 5,\r\n                \"start_range\": 12000,\r\n                \"end_range\": 999999999,\r\n                \"monthly_tax_amount\": 200\r\n            },\r\n            {\r\n                \"id\": \"71d335bb-ff3f-4425-b698-d63982f16154\",\r\n                \"index\": 6,\r\n                \"start_range\": 12000,\r\n                \"end_range\": 999999999,\r\n                \"monthly_tax_amount\": 200\r\n            }\r\n        ],\r\n        \"status\": \"active\",\r\n        \"title\": \"Professional Tax\",\r\n        \"calculationtype\": \"amount\",\r\n        \"isdefault\": true,\r\n        \"branchid\": \"5e954c7b9df11624f81e7859\",\r\n        \"is_ctc\": false,\r\n        \"number\": \"1212121212\",\r\n        \"deduction_cycle\": \"monthly\",\r\n        \"employer_contribution_rate\": \"3.25\",\r\n        \"employee_contribution_rate\": \"0.75\",\r\n        \"include_employers_contribution_ctc\": true,\r\n        \"pro_rate_restricted_pf_wages\": true,\r\n        \"createdAt\": \"2020-09-04T11:48:28.167Z\",\r\n        \"updatedAt\": \"2020-09-29T10:22:49.455Z\",\r\n        \"is_system\": false\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/salarycomponents")

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       \r\n        \"type\": \"statutory\",\r\n        \"percentageofsalarycomponent\": [],\r\n        \"monthly_gross_salary\": [\r\n            {\r\n                \"id\": \"b4ae9bb2-9b10-4a43-bcc4-f333aae7c180\",\r\n                \"index\": 1,\r\n                \"start_range\": 1,\r\n                \"end_range\": 2999,\r\n                \"monthly_tax_amount\": 0\r\n            },\r\n            {\r\n                \"id\": \"ca7464e6-73f3-4d66-98a2-c257212c2471\",\r\n                \"index\": 2,\r\n                \"start_range\": 3000,\r\n                \"end_range\": 5999,\r\n                \"monthly_tax_amount\": 0\r\n            },\r\n            {\r\n                \"id\": \"010f02bd-3fcd-44a7-9218-793bdb622c69\",\r\n                \"index\": 3,\r\n                \"start_range\": 6000,\r\n                \"end_range\": 9999,\r\n                \"monthly_tax_amount\": 100\r\n            },\r\n            {\r\n                \"id\": \"7e66c7b8-1f50-4b39-a60d-bb2ab9f96b52\",\r\n                \"index\": 4,\r\n                \"start_range\": 10000,\r\n                \"end_range\": 11999,\r\n                \"monthly_tax_amount\": 200\r\n            },\r\n            {\r\n                \"id\": \"71d335bb-ff3f-4425-b698-d63982f16154\",\r\n                \"index\": 5,\r\n                \"start_range\": 12000,\r\n                \"end_range\": 999999999,\r\n                \"monthly_tax_amount\": 200\r\n            },\r\n            {\r\n                \"id\": \"71d335bb-ff3f-4425-b698-d63982f16154\",\r\n                \"index\": 6,\r\n                \"start_range\": 12000,\r\n                \"end_range\": 999999999,\r\n                \"monthly_tax_amount\": 200\r\n            }\r\n        ],\r\n        \"status\": \"active\",\r\n        \"title\": \"Professional Tax\",\r\n        \"calculationtype\": \"amount\",\r\n        \"isdefault\": true,\r\n        \"branchid\": \"5e954c7b9df11624f81e7859\",\r\n        \"is_ctc\": false,\r\n        \"number\": \"1212121212\",\r\n        \"deduction_cycle\": \"monthly\",\r\n        \"employer_contribution_rate\": \"3.25\",\r\n        \"employee_contribution_rate\": \"0.75\",\r\n        \"include_employers_contribution_ctc\": true,\r\n        \"pro_rate_restricted_pf_wages\": true,\r\n        \"createdAt\": \"2020-09-04T11:48:28.167Z\",\r\n        \"updatedAt\": \"2020-09-29T10:22:49.455Z\",\r\n        \"is_system\": false\r\n    }"

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

var client = new RestClient("https://live.membroz.com/api/salarycomponents");
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       \r\n        \"type\": \"statutory\",\r\n        \"percentageofsalarycomponent\": [],\r\n        \"monthly_gross_salary\": [\r\n            {\r\n                \"id\": \"b4ae9bb2-9b10-4a43-bcc4-f333aae7c180\",\r\n                \"index\": 1,\r\n                \"start_range\": 1,\r\n                \"end_range\": 2999,\r\n                \"monthly_tax_amount\": 0\r\n            },\r\n            {\r\n                \"id\": \"ca7464e6-73f3-4d66-98a2-c257212c2471\",\r\n                \"index\": 2,\r\n                \"start_range\": 3000,\r\n                \"end_range\": 5999,\r\n                \"monthly_tax_amount\": 0\r\n            },\r\n            {\r\n                \"id\": \"010f02bd-3fcd-44a7-9218-793bdb622c69\",\r\n                \"index\": 3,\r\n                \"start_range\": 6000,\r\n                \"end_range\": 9999,\r\n                \"monthly_tax_amount\": 100\r\n            },\r\n            {\r\n                \"id\": \"7e66c7b8-1f50-4b39-a60d-bb2ab9f96b52\",\r\n                \"index\": 4,\r\n                \"start_range\": 10000,\r\n                \"end_range\": 11999,\r\n                \"monthly_tax_amount\": 200\r\n            },\r\n            {\r\n                \"id\": \"71d335bb-ff3f-4425-b698-d63982f16154\",\r\n                \"index\": 5,\r\n                \"start_range\": 12000,\r\n                \"end_range\": 999999999,\r\n                \"monthly_tax_amount\": 200\r\n            },\r\n            {\r\n                \"id\": \"71d335bb-ff3f-4425-b698-d63982f16154\",\r\n                \"index\": 6,\r\n                \"start_range\": 12000,\r\n                \"end_range\": 999999999,\r\n                \"monthly_tax_amount\": 200\r\n            }\r\n        ],\r\n        \"status\": \"active\",\r\n        \"title\": \"Professional Tax\",\r\n        \"calculationtype\": \"amount\",\r\n        \"isdefault\": true,\r\n        \"branchid\": \"5e954c7b9df11624f81e7859\",\r\n        \"is_ctc\": false,\r\n        \"number\": \"1212121212\",\r\n        \"deduction_cycle\": \"monthly\",\r\n        \"employer_contribution_rate\": \"3.25\",\r\n        \"employee_contribution_rate\": \"0.75\",\r\n        \"include_employers_contribution_ctc\": true,\r\n        \"pro_rate_restricted_pf_wages\": true,\r\n        \"createdAt\": \"2020-09-04T11:48:28.167Z\",\r\n        \"updatedAt\": \"2020-09-29T10:22:49.455Z\",\r\n        \"is_system\": false\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

{
    "type": "statutory",
    "percentageofsalarycomponent": [],
    "is_ctc": false,
    "is_system": false,
    "monthly_gross_salary": [
        {
            "id": "b4ae9bb2-9b10-4a43-bcc4-f333aae7c180",
            "index": 1,
            "start_range": 1,
            "end_range": 2999,
            "monthly_tax_amount": 0
        },
        {
            "id": "ca7464e6-73f3-4d66-98a2-c257212c2471",
            "index": 2,
            "start_range": 3000,
            "end_range": 5999,
            "monthly_tax_amount": 0
        },
        {
            "id": "010f02bd-3fcd-44a7-9218-793bdb622c69",
            "index": 3,
            "start_range": 6000,
            "end_range": 9999,
            "monthly_tax_amount": 100
        }
    ],
    "status": "active",
    "_id": "5f742e272d0fd7365af6101d",
    "title": "Professional Tax",
    "calculationtype": "amount",
    "isdefault": true,
    "branchid": "5e954c7b9df11624f81e7859",
    "number": "1212121212",
    "deduction_cycle": "monthly",
    "employer_contribution_rate": "3.25",
    "employee_contribution_rate": "0.75",
    "include_employers_contribution_ctc": true,
    "pro_rate_restricted_pf_wages": true,
    "createdAt": "2020-09-30T07:05:11.575Z",
    "updatedAt": "2020-09-30T07:05:11.575Z"
}