Skip to main content
POST
/
contract
/
v1
/
monthly-variable-compensations
Create a monthly variable compensation
curl --request POST \
  --url https://api-{region}.sesametime.com/contract/v1/monthly-variable-compensations \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "salaryCompensationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "date": "2024-01-15",
  "amount": 500
}
'
import requests

url = "https://api-{region}.sesametime.com/contract/v1/monthly-variable-compensations"

payload = {
    "salaryCompensationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "date": "2024-01-15",
    "amount": 500
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    salaryCompensationId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    date: '2024-01-15',
    amount: 500
  })
};

fetch('https://api-{region}.sesametime.com/contract/v1/monthly-variable-compensations', 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-{region}.sesametime.com/contract/v1/monthly-variable-compensations",
  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([
    'salaryCompensationId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'date' => '2024-01-15',
    'amount' => 500
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$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-{region}.sesametime.com/contract/v1/monthly-variable-compensations"

	payload := strings.NewReader("{\n  \"salaryCompensationId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"date\": \"2024-01-15\",\n  \"amount\": 500\n}")

	req, _ := http.NewRequest("POST", url, payload)

	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-{region}.sesametime.com/contract/v1/monthly-variable-compensations")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"salaryCompensationId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"date\": \"2024-01-15\",\n  \"amount\": 500\n}")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://api-{region}.sesametime.com/contract/v1/monthly-variable-compensations")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"salaryCompensationId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"date\": \"2024-01-15\",\n  \"amount\": 500\n}"

response = http.request(request)
puts response.read_body
{
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "salaryCompensationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "amount": 500,
    "date": "2024-01-15",
    "createdAt": "2020-01-01T10:00:00+01:00",
    "updatedAt": "2020-01-01T10:00:00+01:00"
  }
}
{
  "message": "Validation failed",
  "errors": [
    {
      "field": "questionId",
      "message": "This value is not a valid UUID."
    },
    {
      "field": "answer",
      "message": "This field is required for text-based questions."
    }
  ]
}
{
  "message": "Invalid or missing API Key",
  "code": "UNAUTHORIZED"
}
{
  "message": "Evaluation with ID 123e4567-e89b-12d3-a456-426614174000 was not found",
  "code": "EVALUATION_NOT_FOUND"
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
salaryCompensationId
string<uuid>
required

Salary compensation ID (employee-compensation assignment)

date
string<date>
required

Date of the compensation (YYYY-MM-DD). Must be a valid pay day.

Example:

"2024-01-15"

amount
number
required

Compensation amount for the month

Example:

500

Response

Successful response

data
object