Update employment compensation
curl --request POST \
--url https://api.kombo.dev/v1/hris/employments/{employment_id}/form/compensation \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'X-Integration-Id: <x-integration-id>' \
--data '
{
"properties": {
"effectiveDate": "2026-11-01",
"amount": 75000,
"reason": "4wPdBNLfMYBeXjNiQ5zKbStR"
}
}
'import requests
url = "https://api.kombo.dev/v1/hris/employments/{employment_id}/form/compensation"
payload = { "properties": {
"effectiveDate": "2026-11-01",
"amount": 75000,
"reason": "4wPdBNLfMYBeXjNiQ5zKbStR"
} }
headers = {
"X-Integration-Id": "<x-integration-id>",
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'X-Integration-Id': '<x-integration-id>',
Authorization: 'Bearer <token>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
properties: {effectiveDate: '2026-11-01', amount: 75000, reason: '4wPdBNLfMYBeXjNiQ5zKbStR'}
})
};
fetch('https://api.kombo.dev/v1/hris/employments/{employment_id}/form/compensation', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.kombo.dev/v1/hris/employments/{employment_id}/form/compensation",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'properties' => [
'effectiveDate' => '2026-11-01',
'amount' => 75000,
'reason' => '4wPdBNLfMYBeXjNiQ5zKbStR'
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json",
"X-Integration-Id: <x-integration-id>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.kombo.dev/v1/hris/employments/{employment_id}/form/compensation"
payload := strings.NewReader("{\n \"properties\": {\n \"effectiveDate\": \"2026-11-01\",\n \"amount\": 75000,\n \"reason\": \"4wPdBNLfMYBeXjNiQ5zKbStR\"\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-Integration-Id", "<x-integration-id>")
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.kombo.dev/v1/hris/employments/{employment_id}/form/compensation")
.header("X-Integration-Id", "<x-integration-id>")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"properties\": {\n \"effectiveDate\": \"2026-11-01\",\n \"amount\": 75000,\n \"reason\": \"4wPdBNLfMYBeXjNiQ5zKbStR\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.kombo.dev/v1/hris/employments/{employment_id}/form/compensation")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-Integration-Id"] = '<x-integration-id>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"properties\": {\n \"effectiveDate\": \"2026-11-01\",\n \"amount\": 75000,\n \"reason\": \"4wPdBNLfMYBeXjNiQ5zKbStR\"\n }\n}"
response = http.request(request)
puts response.read_body{
"status": "success",
"data": {
"status": "COMPLETED",
"remote_url": "https://my.hris.com/employees/12345"
}
}
Update employment
Update employment compensation
Update an employment’s compensation using values from the compensation form.
POST
/
hris
/
employments
/
{employment_id}
/
form
/
compensation
Update employment compensation
curl --request POST \
--url https://api.kombo.dev/v1/hris/employments/{employment_id}/form/compensation \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'X-Integration-Id: <x-integration-id>' \
--data '
{
"properties": {
"effectiveDate": "2026-11-01",
"amount": 75000,
"reason": "4wPdBNLfMYBeXjNiQ5zKbStR"
}
}
'import requests
url = "https://api.kombo.dev/v1/hris/employments/{employment_id}/form/compensation"
payload = { "properties": {
"effectiveDate": "2026-11-01",
"amount": 75000,
"reason": "4wPdBNLfMYBeXjNiQ5zKbStR"
} }
headers = {
"X-Integration-Id": "<x-integration-id>",
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'X-Integration-Id': '<x-integration-id>',
Authorization: 'Bearer <token>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
properties: {effectiveDate: '2026-11-01', amount: 75000, reason: '4wPdBNLfMYBeXjNiQ5zKbStR'}
})
};
fetch('https://api.kombo.dev/v1/hris/employments/{employment_id}/form/compensation', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.kombo.dev/v1/hris/employments/{employment_id}/form/compensation",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'properties' => [
'effectiveDate' => '2026-11-01',
'amount' => 75000,
'reason' => '4wPdBNLfMYBeXjNiQ5zKbStR'
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json",
"X-Integration-Id: <x-integration-id>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.kombo.dev/v1/hris/employments/{employment_id}/form/compensation"
payload := strings.NewReader("{\n \"properties\": {\n \"effectiveDate\": \"2026-11-01\",\n \"amount\": 75000,\n \"reason\": \"4wPdBNLfMYBeXjNiQ5zKbStR\"\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-Integration-Id", "<x-integration-id>")
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.kombo.dev/v1/hris/employments/{employment_id}/form/compensation")
.header("X-Integration-Id", "<x-integration-id>")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"properties\": {\n \"effectiveDate\": \"2026-11-01\",\n \"amount\": 75000,\n \"reason\": \"4wPdBNLfMYBeXjNiQ5zKbStR\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.kombo.dev/v1/hris/employments/{employment_id}/form/compensation")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-Integration-Id"] = '<x-integration-id>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"properties\": {\n \"effectiveDate\": \"2026-11-01\",\n \"amount\": 75000,\n \"reason\": \"4wPdBNLfMYBeXjNiQ5zKbStR\"\n }\n}"
response = http.request(request)
puts response.read_body{
"status": "success",
"data": {
"status": "COMPLETED",
"remote_url": "https://my.hris.com/employees/12345"
}
}
Closed Beta Feature: This endpoint is now in closed beta. Please reach out to your account manager or support.
null clears a value.
Error messages are written so you can show them to your users. When the HRIS refuses a value and names the field, the error message starts with the field key, so you can show it on that field. Some HRIS save a form in several steps. If a later step fails, the earlier ones stay saved, and the error says which part was saved and which part to send again.
If a request times out, or fails with an error that does not say what was saved, the HRIS may still have saved the change. Check the employee in the HRIS before you send the form again.
This endpoint requires the permission Update compensation to be enabled in your scope config.
Example Request Body
{
"properties": {
"effectiveDate": "2026-11-01",
"amount": 75000,
"reason": "4wPdBNLfMYBeXjNiQ5zKbStR"
}
}
Authorizations
Create an API key on the Secrets page in the Kombo dashboard.
Path Parameters
The Kombo ID of the employment, or its HRIS ID with a remote: prefix. Find it in employments on the employee, or with Get employments.
Example:
"remote:67890"
Body
application/json
POST /hris/employments/:employment_id/form/compensation Request body
Was this page helpful?