Create compensation for user

post

https://acmecompany.clayhr.com/rm/api/user/compensation/add

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

value

string

required

Value of compensation

compensationType

string

enum

required

Type of compensation. sal - Salary, pay - , INCTV - Incentive, SVCR - Severance

Allowed:

userId

string

required

ID of user

currencyCode

string

required

period

string

enum

required

Time period for compensation. HRLY - Hourly, DLY - Daily, WKLY - Weekly, BWKLY - Bi-Weekly, MTHLY - Monthly, BMTH - Bi-Monthly, QTRLY - Quarterly, BYRLY - Bi-Yearly, YRLY - Yearly, ONEF - OneOff

effectivedate

date

required

enddate

date

status

string

enum

required

Status of compensation. ACTV - Active, ARCHV - Archive, PVNL - Provisional

Allowed:

notes

string

Headers

userid

int32

required

The ID of the user to authenticate.

x-api-key

string

required

The API key of the user to authenticate.

Responses

Language

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

201201

400400

401401