Skip to main content
POST
/
contract
/
v1
/
compensations
Create a new compensation
curl --request POST \
  --url https://api-{region}.sesametime.com/contract/v1/compensations \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Comision por ventas",
  "compensationType": "fixed",
  "period": "weekly",
  "currency": "MXN",
  "status": "active",
  "quantity": 1500,
  "percentage": 10.5,
  "recurrence": 1,
  "code": "<string>",
  "comment": "<string>"
}
'
{
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "companyId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "Comision por ventas",
    "compensationType": "fixed",
    "quantity": 1500,
    "percentage": 10.5,
    "period": "weekly",
    "currency": "MXN",
    "recurrence": 1,
    "status": "active",
    "origin": "payroll",
    "code": "<string>",
    "comment": "<string>",
    "createdAt": "2020-01-01T10:00:00+01:00",
    "updatedAt": "2020-01-01T10:00:00+01:00"
  },
  "meta": {
    "currentPage": 1,
    "lastPage": 1,
    "total": 1,
    "perPage": 1
  }
}

Authorizations

​
Authorization
string
header
required

API token obtained from Sesame HR Dashboard > Settings > Integrations > API

Body

application/json
​
name
string
required

Compensation name

Example:

"Comision por ventas"

​
compensationType
enum<string>
required

Type: fixed requires quantity; variable/additional require quantity OR percentage

Available options:
fixed,
variable,
additional
​
period
enum<string>
required

Payment period (yearly is NOT valid for payroll)

Available options:
weekly,
biweekly,
fortnightly,
monthly
​
currency
string
required

Currency code (ISO 4217)

Example:

"MXN"

​
status
enum<string>
required

Compensation status

Available options:
active,
inactive
​
quantity
number | null

Fixed amount (required for fixed type, mutually exclusive with percentage)

Example:

1500

​
percentage
number | null

Percentage of gross salary (mutually exclusive with quantity)

Example:

10.5

​
recurrence
integer
default:1

Payment recurrence (default: 1)

​
code
string | null

External code (for Contpaqi integration)

​
comment
string | null

Optional comment

Response

Successful response

​
data
object
​
meta
object