compensation

Get Many Compensations

Authorizations:

query Parameters

select	Array of strings Select Compensation fields, comma-separated. (e.g. `select=id,firstName,lastName,workEmail`) Items Enum: "id" "employeeId" "companyId" "amount" "effectiveDate" "baseAmount" "exchangeRate" "currency" "payoutDay" "payoutPeriod" "payoutFrequency" "salarySchedule" "paidOvertime" "note" "salaryCode"
	object Filters conditions per field. (e.g. `filters[id][$eq]=507f1f77bcf86cd799439011`)
limit	integer Limit amount of received Compensations. (e.g. `limit=20`)
offset	integer Offset amount of received Compensations. (e.g. `offset=20`)
	object Sort received Compensations by field. (e.g. `sort[id]=asc`)

Responses

Request samples

curl
Node.js
Python
C#
Java

curl -i -X GET \
  https://api.alexishr.com/v1/compensation \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Response samples

200
400
401
403
500

Content type

application/json

{"status": "ok",
"data": [{"id": "507f1f77bcf86cd799439011",
"employeeId": "507f1f77bcf86cd799439011",
"companyId": "507f1f77bcf86cd799439011",
"amount": 0,
"effectiveDate": "2019-08-24T14:15:22Z",
"baseAmount": 0,
"exchangeRate": 0,
"currency": "SEK",
"payoutDay": 25,
"payoutPeriod": "MONTHLY",
"payoutFrequency": "MONTH",
"salarySchedule": "ADVANCE",
"paidOvertime": false,
"note": "string",
"salaryCode": "string"
}
],
"total": 500,
"count": 50,
"offset": 50,
"relations": { }
}

Create One Compensation

Authorizations:

bearer

Request Body schema: application/json

employeeId required	string
userId required	string
companyId	string
amount required	number
effectiveDate required	string
currency required	string Enum: "SEK" "NOK" "DKK" "EUR" "USD" "AED" "AFN" "ALL" "AMD" "ANG" "AOA" "ARS" "AUD" "AWG" "AZN" "BAM" "BBD" "BDT" "BGN" "BHD" "BIF" "BMD" "BND" "BOB" "BRL" "BSD" "BTC" "BTN" "BWP" "BYN" "BZD" "CAD" "CDF" "CHF" "CLF" "CLP" "CNH" "CNY" "COP" "CRC" "CUC" "CUP" "CVE" "CZK" "DJF" "DOP" "DZD" "EGP" "ERN" "ETB" "FJD" "FKP" "GBP" "GEL" "GGP" "GHS" "GIP" "GMD" "GNF" "GTQ" "GYD" "HKD" "HNL" "HRK" "HTG" "HUF" "IDR" "ILS" "IMP" "INR" "IQD" "IRR" "ISK" "JEP" "JMD" "JOD" "JPY" "KES" "KGS" "KHR" "KMF" "KPW" "KRW" "KWD" "KYD" "KZT" "LAK" "LBP" "LKR" "LRD" "LSL" "LYD" "MAD" "MDL" "MGA" "MKD" "MMK" "MNT" "MOP" "MRO" "MRU" "MUR" "MVR" "MWK" "MXN" "MYR" "MZN" "NAD" "NGN" "NIO" "NPR" "NZD" "OMR" "PAB" "PEN" "PGK" "PHP" "PKR" "PLN" "PYG" "QAR" "RON" "RSD" "RUB" "RWF" "SAR" "SBD" "SCR" "SDG" "SGD" "SHP" "SLL" "SOS" "SRD" "SSP" "STD" "STN" "SVC" "SYP" "SZL" "THB" "TJS" "TMT" "TND" "TOP" "TRY" "TTD" "TWD" "TZS" "UAH" "UGX" "UYU" "UZS" "VEF" "VND" "VUV" "WST" "XAF" "XAG" "XAU" "XCD" "XDR" "XOF" "XPD" "XPF" "XPT" "YER" "ZAR" "ZMW" "ZWL"
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"
paidOvertime required	boolean
note	string
salaryCode	string

Responses

Request samples

curl
Node.js
Python
C#
Java

curl -i -X POST \
  https://api.alexishr.com/v1/compensation \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "employeeId": "507f1f77bcf86cd799439011",
    "userId": "507f1f77bcf86cd799439011",
    "amount": 0,
    "effectiveDate": "string",
    "currency": "SEK",
    "payoutDay": 25,
    "payoutPeriod": "MONTHLY",
    "payoutFrequency": "MONTH",
    "paidOvertime": false
  }'

Response samples

201
400
401
403
500

Content type

application/json

{"status": "ok",
"data": {"id": "507f1f77bcf86cd799439011",
"employeeId": "507f1f77bcf86cd799439011",
"companyId": "507f1f77bcf86cd799439011",
"amount": 0,
"effectiveDate": "2019-08-24T14:15:22Z",
"baseAmount": 0,
"exchangeRate": 0,
"currency": "SEK",
"payoutDay": 25,
"payoutPeriod": "MONTHLY",
"payoutFrequency": "MONTH",
"salarySchedule": "ADVANCE",
"paidOvertime": false,
"note": "string",
"salaryCode": "string"
}
}

Get One Compensation

Authorizations:

bearer

path Parameters

id

required

string

Resource Id

Example: 507f1f77bcf86cd799439011

query Parameters

select

Array of strings

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

Items Enum: "id" "employeeId" "companyId" "amount" "effectiveDate" "baseAmount" "exchangeRate" "currency" "payoutDay" "payoutPeriod" "payoutFrequency" "salarySchedule" "paidOvertime" "note" "salaryCode"

Responses

Request samples

curl
Node.js
Python
C#
Java

curl -i -X GET \
  https://api.alexishr.com/v1/compensation/:id \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Response samples

Content type

application/json

{"status": "ok",
"data": {"id": "507f1f77bcf86cd799439011",
"employeeId": "507f1f77bcf86cd799439011",
"companyId": "507f1f77bcf86cd799439011",
"amount": 0,
"effectiveDate": "2019-08-24T14:15:22Z",
"baseAmount": 0,
"exchangeRate": 0,
"currency": "SEK",
"payoutDay": 25,
"payoutPeriod": "MONTHLY",
"payoutFrequency": "MONTH",
"salarySchedule": "ADVANCE",
"paidOvertime": false,
"note": "string",
"salaryCode": "string"
},
"relations": { }
}

Update One Compensation

Authorizations:

bearer

path Parameters

id

required

string

Resource Id

Example: 507f1f77bcf86cd799439011

Request Body schema: application/json

employeeId	string
userId	string
amount	number
currency	string Enum: "SEK" "NOK" "DKK" "EUR" "USD" "AED" "AFN" "ALL" "AMD" "ANG" "AOA" "ARS" "AUD" "AWG" "AZN" "BAM" "BBD" "BDT" "BGN" "BHD" "BIF" "BMD" "BND" "BOB" "BRL" "BSD" "BTC" "BTN" "BWP" "BYN" "BZD" "CAD" "CDF" "CHF" "CLF" "CLP" "CNH" "CNY" "COP" "CRC" "CUC" "CUP" "CVE" "CZK" "DJF" "DOP" "DZD" "EGP" "ERN" "ETB" "FJD" "FKP" "GBP" "GEL" "GGP" "GHS" "GIP" "GMD" "GNF" "GTQ" "GYD" "HKD" "HNL" "HRK" "HTG" "HUF" "IDR" "ILS" "IMP" "INR" "IQD" "IRR" "ISK" "JEP" "JMD" "JOD" "JPY" "KES" "KGS" "KHR" "KMF" "KPW" "KRW" "KWD" "KYD" "KZT" "LAK" "LBP" "LKR" "LRD" "LSL" "LYD" "MAD" "MDL" "MGA" "MKD" "MMK" "MNT" "MOP" "MRO" "MRU" "MUR" "MVR" "MWK" "MXN" "MYR" "MZN" "NAD" "NGN" "NIO" "NPR" "NZD" "OMR" "PAB" "PEN" "PGK" "PHP" "PKR" "PLN" "PYG" "QAR" "RON" "RSD" "RUB" "RWF" "SAR" "SBD" "SCR" "SDG" "SGD" "SHP" "SLL" "SOS" "SRD" "SSP" "STD" "STN" "SVC" "SYP" "SZL" "THB" "TJS" "TMT" "TND" "TOP" "TRY" "TTD" "TWD" "TZS" "UAH" "UGX" "UYU" "UZS" "VEF" "VND" "VUV" "WST" "XAF" "XAG" "XAU" "XCD" "XDR" "XOF" "XPD" "XPF" "XPT" "YER" "ZAR" "ZMW" "ZWL"
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"
paidOvertime	boolean
note	string
salaryCode	string

Responses

Request samples

curl
Node.js
Python
C#
Java

curl -i -X PATCH \
  https://api.alexishr.com/v1/compensation/:id \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{}'

Response samples

Content type

application/json

{"status": "ok",
"data": {"id": "507f1f77bcf86cd799439011",
"employeeId": "507f1f77bcf86cd799439011",
"companyId": "507f1f77bcf86cd799439011",
"amount": 0,
"effectiveDate": "2019-08-24T14:15:22Z",
"baseAmount": 0,
"exchangeRate": 0,
"currency": "SEK",
"payoutDay": 25,
"payoutPeriod": "MONTHLY",
"payoutFrequency": "MONTH",
"salarySchedule": "ADVANCE",
"paidOvertime": false,
"note": "string",
"salaryCode": "string"
}
}

Replace One Compensation

Authorizations:

bearer

path Parameters

id

required

string

Resource Id

Example: 507f1f77bcf86cd799439011

Request Body schema: application/json

employeeId	string
userId	string
amount	number
currency	string Enum: "SEK" "NOK" "DKK" "EUR" "USD" "AED" "AFN" "ALL" "AMD" "ANG" "AOA" "ARS" "AUD" "AWG" "AZN" "BAM" "BBD" "BDT" "BGN" "BHD" "BIF" "BMD" "BND" "BOB" "BRL" "BSD" "BTC" "BTN" "BWP" "BYN" "BZD" "CAD" "CDF" "CHF" "CLF" "CLP" "CNH" "CNY" "COP" "CRC" "CUC" "CUP" "CVE" "CZK" "DJF" "DOP" "DZD" "EGP" "ERN" "ETB" "FJD" "FKP" "GBP" "GEL" "GGP" "GHS" "GIP" "GMD" "GNF" "GTQ" "GYD" "HKD" "HNL" "HRK" "HTG" "HUF" "IDR" "ILS" "IMP" "INR" "IQD" "IRR" "ISK" "JEP" "JMD" "JOD" "JPY" "KES" "KGS" "KHR" "KMF" "KPW" "KRW" "KWD" "KYD" "KZT" "LAK" "LBP" "LKR" "LRD" "LSL" "LYD" "MAD" "MDL" "MGA" "MKD" "MMK" "MNT" "MOP" "MRO" "MRU" "MUR" "MVR" "MWK" "MXN" "MYR" "MZN" "NAD" "NGN" "NIO" "NPR" "NZD" "OMR" "PAB" "PEN" "PGK" "PHP" "PKR" "PLN" "PYG" "QAR" "RON" "RSD" "RUB" "RWF" "SAR" "SBD" "SCR" "SDG" "SGD" "SHP" "SLL" "SOS" "SRD" "SSP" "STD" "STN" "SVC" "SYP" "SZL" "THB" "TJS" "TMT" "TND" "TOP" "TRY" "TTD" "TWD" "TZS" "UAH" "UGX" "UYU" "UZS" "VEF" "VND" "VUV" "WST" "XAF" "XAG" "XAU" "XCD" "XDR" "XOF" "XPD" "XPF" "XPT" "YER" "ZAR" "ZMW" "ZWL"
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"
paidOvertime	boolean
note	string
salaryCode	string

Responses

Request samples

curl
Node.js
Python
C#
Java

curl -i -X PUT \
  https://api.alexishr.com/v1/compensation/:id \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{}'

Response samples

Content type

application/json

{"status": "ok",
"data": {"id": "507f1f77bcf86cd799439011",
"employeeId": "507f1f77bcf86cd799439011",
"companyId": "507f1f77bcf86cd799439011",
"amount": 0,
"effectiveDate": "2019-08-24T14:15:22Z",
"baseAmount": 0,
"exchangeRate": 0,
"currency": "SEK",
"payoutDay": 25,
"payoutPeriod": "MONTHLY",
"payoutFrequency": "MONTH",
"salarySchedule": "ADVANCE",
"paidOvertime": false,
"note": "string",
"salaryCode": "string"
}
}

Delete One Compensation

Authorizations:

bearer

path Parameters

id

required

string

Resource Id

Example: 507f1f77bcf86cd799439011

Responses

Request samples

curl
Node.js
Python
C#
Java

curl -i -X DELETE \
  https://api.alexishr.com/v1/compensation/:id \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Response samples

Content type

application/json

{"status": "ok",
"data": { }
}