Skip to main content
POST
Create a new compensation

Authorizations

Authorization
string
header
required

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

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