List Employee Payrolls
GET {{baseUrl}}/hris/payrolls/employees/:employee_id?raw=false&filter[start_date]=2022-04-08&filter[end_date]=2022-04-21&pass_through[search]=San Francisco
List payrolls for employee
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
raw | boolean | Include raw response. Mostly used for debugging purposes | |
filter[start_date] | string | Apply filters | |
filter[end_date] | string | Apply filters | |
pass_through[search] | string | Optional unmapped key/values that will be passed through to downstream as query parameters. Ie: ?pass_through[search]=leads becomes ?search=leads | |
fields | string | The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation. <br /><br />Example: fields=name,email,addresses.city<br /><br />In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded. | |
cursor | null | ||
filter[company_id] | null |
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
x-apideck-consumer-id | string | (Required) ID of the consumer which you want to get or push data from | |
x-apideck-app-id | string | (Required) The ID of your Unify application | |
x-apideck-service-id | string | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | |
Accept | string |
RESPONSES
status: OK
{"status_code":200,"status":"OK","service":"sage-hr","resource":"Employees","operation":"all","data":[{"id":"12345","processed":false,"check_date":"2022-04-08","start_date":"2022-04-08","end_date":"2022-04-21","employee_id":"12345","company_id":"23456","processed_date":"2022-04-08","totals":{"company_debit":27992.49,"tax_debit":8655.32,"check_amount":27966.23,"net_pay":19337.17,"gross_pay":27966.23,"employer_taxes":2038.93,"employee_taxes":6616.39,"employer_benefit_contributions":0,"employee_benefit_deductions":0},"compensations":[{"employee_id":"12345","net_pay":2199.93,"gross_pay":3000,"taxes":[{"name":"CA State Income Tax","employer":false,"amount":1.97},{"name":"CA State Income Tax","employer":false,"amount":1.97}],"deductions":[{"name":"Company Car","amount":10.97},{"name":"Company Car","amount":10.97}],"benefits":[{"name":"Health Insurance","employee_deduction":142.94,"employer_contribution":141.14},{"name":"Health Insurance","employee_deduction":142.94,"employer_contribution":141.14}]},{"employee_id":"12345","net_pay":2199.93,"gross_pay":3000,"taxes":[{"name":"CA State Income Tax","employer":false,"amount":1.97},{"name":"CA State Income Tax","employer":false,"amount":1.97}],"deductions":[{"name":"Company Car","amount":10.97},{"name":"Company Car","amount":10.97}],"benefits":[{"name":"Health Insurance","employee_deduction":142.94,"employer_contribution":141.14},{"name":"Health Insurance","employee_deduction":142.94,"employer_contribution":141.14}]}]},{"id":"12345","processed":false,"check_date":"2022-04-08","start_date":"2022-04-08","end_date":"2022-04-21","employee_id":"12345","company_id":"23456","processed_date":"2022-04-08","totals":{"company_debit":27992.49,"tax_debit":8655.32,"check_amount":27966.23,"net_pay":19337.17,"gross_pay":27966.23,"employer_taxes":2038.93,"employee_taxes":6616.39,"employer_benefit_contributions":0,"employee_benefit_deductions":0},"compensations":[{"employee_id":"12345","net_pay":2199.93,"gross_pay":3000,"taxes":[{"name":"CA State Income Tax","employer":false,"amount":1.97},{"name":"CA State Income Tax","employer":false,"amount":1.97}],"deductions":[{"name":"Company Car","amount":10.97},{"name":"Company Car","amount":10.97}],"benefits":[{"name":"Health Insurance","employee_deduction":142.94,"employer_contribution":141.14},{"name":"Health Insurance","employee_deduction":142.94,"employer_contribution":141.14}]},{"employee_id":"12345","net_pay":2199.93,"gross_pay":3000,"taxes":[{"name":"CA State Income Tax","employer":false,"amount":1.97},{"name":"CA State Income Tax","employer":false,"amount":1.97}],"deductions":[{"name":"Company Car","amount":10.97},{"name":"Company Car","amount":10.97}],"benefits":[{"name":"Health Insurance","employee_deduction":142.94,"employer_contribution":141.14},{"name":"Health Insurance","employee_deduction":142.94,"employer_contribution":141.14}]}]}]}