PeopleForce
Employees

Deprecated

Company API v1 is deprecated and will be removed in a future release. Migrate to a newer version — v4 is the latest. Use the version switcher in the header.

Create an employee additional compensation

POST
/api/public/v1/employees/{employee_id}/additional_compensations

Path Parameters

employee_id*integer

Request Body

application/x-www-form-urlencoded

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

curl -X POST "https://example.com/api/public/v1/employees/0/additional_compensations" \  -H "Content-Type: application/x-www-form-urlencoded" \  -d 'compensation_type_id=string&starts_on=string&amount=string&currency_code=string'
{  "data": {    "id": 0,    "type": "string",    "description": "string",    "amount": "string",    "currency_code": "string",    "starts_on": "string",    "created_at": "string",    "updated_at": "string",    "compensation_type": {      "id": 0,      "name": "string"    },    "frequency": "string",    "ends_on": "string",    "custom_fields": {      "1": {        "name": "string",        "value": "string"      },      "2": {        "name": "string",        "value": "string"      },      "3": {        "name": "string",        "value": "string"      },      "4": {        "name": "string",        "value": "string"      },      "5": {        "name": "string",        "value": "string"      },      "6": {        "name": "string",        "value": "string"      },      "7": {        "name": "string",        "value": "string"      },      "9": {        "name": "string",        "value": "string"      },      "10": {        "name": "string",        "value": "string"      },      "12": {        "name": "string",        "value": "string"      },      "13": {        "name": "string",        "value": "string"      },      "15": {        "name": "string",        "value": "string"      },      "48": {        "name": "string",        "value": "string"      },      "49": {        "name": "string",        "value": "string"      },      "50": {        "name": "string",        "value": "string"      },      "51": {        "name": "string",        "value": "string"      },      "52": {        "name": "string",        "value": "string"      },      "53": {        "name": "string",        "value": "string"      },      "54": {        "name": "string",        "value": "string"      },      "56": {        "name": "string",        "value": "string"      },      "57": {        "name": "string",        "value": "string"      },      "59": {        "name": "string",        "value": "string"      },      "60": {        "name": "string",        "value": "string"      },      "62": {        "name": "string",        "value": "string"      },      "63": {        "name": "string",        "value": "string"      },      "64": {        "name": "string",        "value": "string"      },      "65": {        "name": "string",        "value": "string"      },      "66": {        "name": "string",        "value": "string"      },      "67": {        "name": "string",        "value": "string"      },      "68": {        "name": "string",        "value": "string"      },      "69": {        "name": "string",        "value": "string"      },      "71": {        "name": "string",        "value": "string"      },      "72": {        "name": "string",        "value": "string"      },      "74": {        "name": "string",        "value": "string"      },      "75": {        "name": "string",        "value": "string"      },      "77": {        "name": "string",        "value": "string"      },      "116": {        "name": "string",        "value": "string"      },      "118": {        "name": "string",        "value": "string"      },      "119": {        "name": "string",        "value": "string"      },      "120": {        "name": "string",        "value": "string"      },      "121": {        "name": "string",        "value": "string"      },      "122": {        "name": "string",        "value": "string"      },      "123": {        "name": "string",        "value": "string"      },      "126": {        "name": "string",        "value": "string"      },      "128": {        "name": "string",        "value": "string"      },      "130": {        "name": "string",        "value": "string"      },      "131": {        "name": "string",        "value": "string"      },      "133": {        "name": "string",        "value": "string"      },      "221": {        "name": "string",        "value": "string"      },      "222": {        "name": "string",        "value": "string"      },      "223": {        "name": "string",        "value": "string"      },      "224": {        "name": "string",        "value": "string"      },      "225": {        "name": "string",        "value": "string"      },      "226": {        "name": "string",        "value": "string"      },      "227": {        "name": "string",        "value": "string"      },      "229": {        "name": "string",        "value": "string"      },      "230": {        "name": "string",        "value": "string"      },      "232": {        "name": "string",        "value": "string"      },      "233": {        "name": "string",        "value": "string"      },      "235": {        "name": "string",        "value": "string"      }    }  }}