additional-compensation

Get Many Additional Compensations

Get Many Additional Compensations

Securitybearer
Request
query Parameters
select
Array of strings

Select Additional Compensation fields, comma-separated. (e.g. select=id,firstName,lastName,workEmail)

Items Enum: "id" "companyId" "employeeId" "userId" "name" "amount" "currencyId" "effectiveDate" "endDate" "payoutDay" "payoutPeriod" "payoutFrequency" "salarySchedule" "note" "salaryCode"
object

Filters conditions per field. (e.g. filters[id][$eq]=507f1f77bcf86cd799439011)

limit
integer

Limit amount of received Additional Compensations. (e.g. limit=20)

offset
integer

Offset amount of received Additional Compensations. (e.g. offset=20)

object

Sort received Additional Compensations by field. (e.g. sort[id]=asc)

Responses
200
400

Bad Request

401

Unauthorized

403

Forbidden

500

Internal server error

get/additional-compensation
Response samples
application/json
{
  • "status": "ok",
  • "data": [
    ],
  • "total": 500,
  • "count": 50,
  • "offset": 50,
  • "relations": { }
}

Create One Additional Compensation

Create One Additional Compensation

Securitybearer
Request
Request Body schema: application/json
required
companyId
required
string
employeeId
required
string
userId
required
string
name
required
string
amount
required
number
currencyId
required
string
effectiveDate
required
string
endDate
string
payoutDay
required
number
payoutPeriod
required
string
Enum: "HOURLY" "DAILY" "WEEKLY" "BI_WEEKLY" "MONTHLY" "QUARTERLY" "ANNUAL"
payoutFrequency
required
string
Enum: "WEEK" "BI_WEEKLY" "MONTH"
salarySchedule
string
Enum: "ADVANCE" "DELAYED"
note
string
salaryCode
string
Responses
201
400

Bad Request

401

Unauthorized

403

Forbidden

500

Internal server error

post/additional-compensation
Request samples
application/json
{
  • "companyId": "507f1f77bcf86cd799439011",
  • "employeeId": "507f1f77bcf86cd799439011",
  • "userId": "507f1f77bcf86cd799439011",
  • "name": "string",
  • "amount": 0,
  • "currencyId": "507f1f77bcf86cd799439011",
  • "effectiveDate": "string",
  • "endDate": "string",
  • "payoutDay": 25,
  • "payoutPeriod": "MONTHLY",
  • "payoutFrequency": "MONTH",
  • "salarySchedule": "ADVANCE",
  • "note": "string",
  • "salaryCode": "string"
}
Response samples
application/json
{
  • "status": "ok",
  • "data": {
    }
}

Get One Additional Compensation

Get One Additional Compensation

Securitybearer
Request
path Parameters
id
required
string

Resource Id

Example: 507f1f77bcf86cd799439011
query Parameters
select
Array of strings

Select Additional Compensation fields, comma-separated. (e.g. select=id,firstName,lastName,workEmail)

Items Enum: "id" "companyId" "employeeId" "userId" "name" "amount" "currencyId" "effectiveDate" "endDate" "payoutDay" "payoutPeriod" "payoutFrequency" "salarySchedule" "note" "salaryCode"
Responses
200
400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal server error

get/additional-compensation/{id}
Response samples
application/json
{
  • "status": "ok",
  • "data": {
    },
  • "relations": { }
}

Update One Additional Compensation

Update One Additional Compensation

Securitybearer
Request
path Parameters
id
required
string

Resource Id

Example: 507f1f77bcf86cd799439011
Request Body schema: application/json
required
name
string
amount
number
currencyId
string
effectiveDate
string
endDate
string
payoutDay
number
payoutPeriod
string
Enum: "HOURLY" "DAILY" "WEEKLY" "BI_WEEKLY" "MONTHLY" "QUARTERLY" "ANNUAL"
payoutFrequency
string
Enum: "WEEK" "BI_WEEKLY" "MONTH"
salarySchedule
string
Enum: "ADVANCE" "DELAYED"
note
string
salaryCode
string
Responses
200
400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal server error

patch/additional-compensation/{id}
Request samples
application/json
{
  • "name": "string",
  • "amount": 0,
  • "currencyId": "507f1f77bcf86cd799439011",
  • "effectiveDate": "string",
  • "endDate": "string",
  • "payoutDay": 25,
  • "payoutPeriod": "MONTHLY",
  • "payoutFrequency": "MONTH",
  • "salarySchedule": "ADVANCE",
  • "note": "string",
  • "salaryCode": "string"
}
Response samples
application/json
{
  • "status": "ok",
  • "data": {
    }
}

Replace One Additional Compensation

Replace One Additional Compensation

Securitybearer
Request
path Parameters
id
required
string

Resource Id

Example: 507f1f77bcf86cd799439011
Request Body schema: application/json
required
name
string
amount
number
currencyId
string
effectiveDate
string
endDate
string
payoutDay
number
payoutPeriod
string
Enum: "HOURLY" "DAILY" "WEEKLY" "BI_WEEKLY" "MONTHLY" "QUARTERLY" "ANNUAL"
payoutFrequency
string
Enum: "WEEK" "BI_WEEKLY" "MONTH"
salarySchedule
string
Enum: "ADVANCE" "DELAYED"
note
string
salaryCode
string
Responses
200
400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal server error

put/additional-compensation/{id}
Request samples
application/json
{
  • "name": "string",
  • "amount": 0,
  • "currencyId": "507f1f77bcf86cd799439011",
  • "effectiveDate": "string",
  • "endDate": "string",
  • "payoutDay": 25,
  • "payoutPeriod": "MONTHLY",
  • "payoutFrequency": "MONTH",
  • "salarySchedule": "ADVANCE",
  • "note": "string",
  • "salaryCode": "string"
}
Response samples
application/json
{
  • "status": "ok",
  • "data": {
    }
}

Delete One Additional Compensation

Delete One Additional Compensation

Securitybearer
Request
path Parameters
id
required
string

Resource Id

Example: 507f1f77bcf86cd799439011
Responses
204
400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal server error

delete/additional-compensation/{id}
Response samples
application/json
{
  • "status": "ok",
  • "data": { }
}
➔ Next to employment