Update a person salary

Update a person salary record

Path Parameters

person_id*integer

Formatint64

id*integer

Formatint64

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Update a person salary record

amount?number

Salary amount

Formatfloat

effective_on?string

Date the salary becomes effective

Formatdate

currency_code?string

Currency code

per?string

Pay period

comment?string

A comment about the salary record

overtime?boolean

Is the person eligible for overtime?

pay_schedule_id?integer

ID of the associated pay schedule

Formatint64

custom_fields?

A hash of custom field values, keyed by internal name

Response Body

`application/json`

curl -X PUT "https://example.com/api/v4/people/0/compensation/salaries/0" \  -H "Content-Type: application/json" \  -d '{}'

{  "data": {    "id": 0,    "effective_on": "2019-08-24",    "amount": "string",    "currency_code": "string",    "per": "string",    "comment": "string",    "created_at": "2019-08-24T14:15:22Z",    "updated_at": "2019-08-24T14:15:22Z",    "custom_fields": {      "property1": {        "name": "string",        "value": null      },      "property2": {        "name": "string",        "value": null      }    }  }}

Update a person salary

Path Parameters

Request Body

Response Body

200application/json

400application/json

401application/json

403application/json

404application/json

422application/json

500application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`