dvl-api-hr-employee-payroll-create.md

HR Employee Payroll Create

• URL

  /v1/employees/:employee_id/payrolls

• Method:

  POST

• HEADERS

  Authorization=bearer ACCESS_TOKEN

URL Params

Required:

employee_id=[integer]

• Data Params

  hr_employee_payroll[pay_day]=[date]
hr_employee_payroll[hours]=[decimal]
hr_employee_payroll[price_per_hour]=[decimal]
hr_employee_payroll[date_from]=[date]
hr_employee_payroll[date_to]=[date]
  

• Success Response:

  • Code: 201 CREATED
    Content: {"data":
{"payroll":{
"id":28,
"pay_day date": "DATE",
"hours": 160.00,
"price_per_hour": 15.50,
"date_from":"DATE_FROM",
"date_to":"DATE_TO",
}}}

• Error Response:

  • Code: 401 UNAUTHORIZED
    Content: { "error": "Invalid access token" }

  OR

  • Code: 401 UNAUTHORIZED
    Content { "error": "You don't have permission" }

  OR

  • Code: 422 UNPROCESSABLE ENTITY
    Content: { "errors": {
"date_from":["can't be blank"],
"date_to":["can't be blank"],
}}
    

• Sample Call:

• Notes:

dvl-api-hr-employee-payroll-delete.md

HR Employee Payroll Delete

• URL

  /v1/employees/:employee_id/payrolls/:id

• Method:

  DELETE

• HEADERS

  Authorization=bearer ACCESS_TOKEN

• URL Params

  Required:

  id=[integer]
employee_id=[integer]

• Data Params

• Success Response:

  • Code: 200 OK
    Content:

• Error Response:

  • Code: 401 UNAUTHORIZED
    Content: { "error": "Invalid access token" }

  OR

  • Code: 401 UNAUTHORIZED
    Content { "error": "You don't have permission" }

  OR

  • Code 404 NOT FOUND
    Content: { "error": "Not Found" }

  OR

  • Code: 404 UNPROCESSABLE ENTITY
    Content:

• Sample Call:

• Notes:

dvl-api-hr-employee-payroll-update.md

HR Employee Payroll Update

• URL

  /v1/employees/:employee_id/payrolls/:id

• Method:

  PUT | PATCH

• HEADERS

  Authorization=bearer ACCESS_TOKEN

• URL Params

  Required:

  id=[integer]
employee_id=[integer]

• Data Params

  hr_employee_payroll[pay_day date]=[date]
hr_employee_payroll[hours]=[decimal]
hr_employee_payroll[price_per_hour]=[decimal]
hr_employee_payroll[date_from]=[date]
hr_employee_payroll[date_to]=[date]
  

• Success Response:

  • Code: 200 OK
    Content: {"data":
{"payroll":{
"id":28,
"pay_day": "DATE",
"hours": 160.00,
"price_per_hour": 15.50,
"date_from":"DATE_FROM",
"date_to":"DATE_TO",
}}}

• Error Response:

  • Code: 401 UNAUTHORIZED
    Content: { "error": "Invalid access token" }

  OR

  • Code: 401 UNAUTHORIZED
    Content { "error": "You don't have permission" }

  OR

  • Code 404 NOT FOUND
    Content: { "error": "Not Found" }

  OR

  • Code: 404 UNPROCESSABLE ENTITY
    Content: { "errors": { "pay_day":["can't be blank"] } }

• Sample Call:

• Notes:

dvl-api-hr-employee-payrolls.md

HR Employee Payrolls List

• URL

  /v1/employees/:employee_id/payrolls

• Method:

  GET

• HEADERS

  Authorization=bearer ACCESS_TOKEN

• URL Params

  Required:

  none

  Optional:

  per_page=[integer]
page=[integer]
q[date_from_eq]=[text]
q[date_to_eq]=[text]
...

• Data Params

  none

• Success Response:

  • Code: 200 OK
    Content: {"data":{
"payrolls":[
{"id":3,"pay_day":"DATE","hours":160.00,"price_per_hour":15.50,"date_from":"DATE_FROM","date_to":"DATE_TO"},
{"id":20,"pay_day":"DATE","hours":160.00,"price_per_hour":15.50,"date_from":"DATE_FROM","date_to":"DATE_TO"}
],
"pagination":{"page":1,"per_page":2,"total":10,"pages":5}}}

• Error Response:

  • Code: 401 UNAUTHORIZED
    Content: { "error": "Invalid access token" }

  OR

  • Code: 401 UNAUTHORIZED
    Content { "error": "You don't have permission" }

• Sample Call:

• Notes:

in search query

*_eq - equal
*_cont Contains value

dvl-api-hr-payrolls.md

HR Payrolls List

• URL

  /v1/hr/payrolls

• Method:

  GET

• HEADERS

  Authorization=bearer ACCESS_TOKEN

• URL Params

  Required:

  none

  Optional:

  per_page=[integer]
page=[integer]
q[date_from_eq]=[text]
q[date_to_eq]=[text]
...

• Data Params

  none

• Success Response:

  • Code: 200 OK
    Content: {"data":{
"payrolls":[
{"id":3,"pay_day":"DATE","hours":160.00,"price_per_hour":15.50,"date_from":"DATE_FROM","date_to":"DATE_TO"},
{"id":20,"pay_day":"DATE","hours":160.00,"price_per_hour":15.50,"date_from":"DATE_FROM","date_to":"DATE_TO"}
],
"pagination":{"page":1,"per_page":2,"total":10,"pages":5}}}

• Error Response:

  • Code: 401 UNAUTHORIZED
    Content: { "error": "Invalid access token" }

  OR

  • Code: 401 UNAUTHORIZED
    Content { "error": "You don't have permission" }

• Sample Call:

• Notes:

in search query

*_eq - equal
*_cont Contains value