OK
Encompass.Api (1.0)
Download OpenAPI description
Languages
Servers
Mock server
https://docs.encompassfi.com/_mock/reference/sandbox/
Bodyapplication/jsonrequired
Enum"Salaried""Hourly""Overtime""DoubleOvertime""PaidHoliday""PTO""Sick""NonHourlyRegular""Bonus""Commission"
- Mock server
https://docs.encompassfi.com/_mock/reference/sandbox/companies/{companyId}/earning_codes
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
'https://docs.encompassfi.com/_mock/reference/sandbox/companies/{companyId}/earning_codes' \
-H 'Content-Type: application/json' \
-d '{
"name": "string",
"type": "Salaried",
"active": true
}'Response
application/json
{ "id": "string", "companyId": "string", "type": "Salaried", "name": "string", "active": true }
- Mock server
https://docs.encompassfi.com/_mock/reference/sandbox/companies/{companyId}/earning_codes
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
'https://docs.encompassfi.com/_mock/reference/sandbox/companies/{companyId}/earning_codes?id=string&name=string&active=true&page=1&pageSize=10'Response
application/json
{ "hasResources": true, "totalResources": 0, "totalPages": 0, "pageSize": 0, "currentPage": 0, "previousPage": 0, "nextPage": 0, "results": [ { … } ] }
- Mock server
https://docs.encompassfi.com/_mock/reference/sandbox/companies/{companyId}/earning_codes/{earningCodeId}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
'https://docs.encompassfi.com/_mock/reference/sandbox/companies/{companyId}/earning_codes/{earningCodeId}'Response
application/json
{ "id": "string", "companyId": "string", "type": "Salaried", "name": "string", "active": true }
- Mock server
https://docs.encompassfi.com/_mock/reference/sandbox/companies/{companyId}/earning_codes/{earningCodeId}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X PATCH \
'https://docs.encompassfi.com/_mock/reference/sandbox/companies/{companyId}/earning_codes/{earningCodeId}' \
-H 'Content-Type: application/json' \
-d '{
"active": true
}'Response
application/json
{ "id": "string", "companyId": "string", "type": "Salaried", "name": "string", "active": true }