bonus-compensation

Get Many Bonus Compensations

Get Many Bonus Compensations

Securitybearer
Request
query Parameters
select
Array of strings

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

Items Enum: "id" "companyId" "employeeId" "userId" "name" "amount" "payoutDate" "currencyId" "note"
object

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

limit
integer

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

offset
integer

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

object

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

Responses
200
400

Bad Request

401

Unauthorized

403

Forbidden

500

Internal server error

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

Create One Bonus Compensation

Create One Bonus Compensation

Securitybearer
Request
Request Body schema: application/json
required
companyId
required
string
employeeId
required
string
userId
required
string
name
required
string
amount
required
number
payoutDate
required
string
currencyId
required
string
note
string
Responses
201
400

Bad Request

401

Unauthorized

403

Forbidden

500

Internal server error

post/bonus-compensation
Request samples
application/json
{
  • "companyId": "507f1f77bcf86cd799439011",
  • "employeeId": "507f1f77bcf86cd799439011",
  • "userId": "507f1f77bcf86cd799439011",
  • "name": "string",
  • "amount": 0,
  • "payoutDate": "string",
  • "currencyId": "507f1f77bcf86cd799439011",
  • "note": "string"
}
Response samples
application/json
{
  • "status": "ok",
  • "data": {
    }
}

Get One Bonus Compensation

Get One Bonus Compensation

Securitybearer
Request
path Parameters
id
required
string

Resource Id

Example: 507f1f77bcf86cd799439011
query Parameters
select
Array of strings

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

Items Enum: "id" "companyId" "employeeId" "userId" "name" "amount" "payoutDate" "currencyId" "note"
Responses
200
400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal server error

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

Update One Bonus Compensation

Update One Bonus Compensation

Securitybearer
Request
path Parameters
id
required
string

Resource Id

Example: 507f1f77bcf86cd799439011
Request Body schema: application/json
required
name
string
amount
number
payoutDate
string
currencyId
string
note
string
Responses
200
400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal server error

patch/bonus-compensation/{id}
Request samples
application/json
{
  • "name": "string",
  • "amount": 0,
  • "payoutDate": "string",
  • "currencyId": "507f1f77bcf86cd799439011",
  • "note": "string"
}
Response samples
application/json
{
  • "status": "ok",
  • "data": {
    }
}

Replace One Bonus Compensation

Replace One Bonus Compensation

Securitybearer
Request
path Parameters
id
required
string

Resource Id

Example: 507f1f77bcf86cd799439011
Request Body schema: application/json
required
name
string
amount
number
payoutDate
string
currencyId
string
note
string
Responses
200
400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal server error

put/bonus-compensation/{id}
Request samples
application/json
{
  • "name": "string",
  • "amount": 0,
  • "payoutDate": "string",
  • "currencyId": "507f1f77bcf86cd799439011",
  • "note": "string"
}
Response samples
application/json
{
  • "status": "ok",
  • "data": {
    }
}

Delete One Bonus Compensation

Delete One Bonus 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/bonus-compensation/{id}
Response samples
application/json
{
  • "status": "ok",
  • "data": { }
}
➔ Next to additional-compensation