---
title: "Get Payroll"
method: GET
path: "/hris/payrolls/{payroll_id}"
tags: ["Payrolls"]
---

# Get Payroll

`GET /hris/payrolls/{payroll_id}`

Get Payroll

## Path parameters

- `payroll_id` string, required

## Query parameters

- `raw` boolean
- `fields` string, nullable

## Headers

- `x-apideck-consumer-id` string, required
- `x-apideck-app-id` string, required
- `x-apideck-service-id` string

## Response `200`

Payrolls

- GetPayrollResponse
  - `status_code` integer, required — HTTP Response Status Code
  - `status` string, required — HTTP Response Status
  - `service` string, required — Apideck ID of service provider
  - `resource` string, required — Unified API resource name
  - `operation` string, required — Operation performed
  - `data` Payroll, required
    - `id` string, nullable, required — A unique identifier for an object.
    - `company_id` string, nullable — The unique identifier of the company.
    - `processed` boolean, nullable, required — Whether or not the payroll has been successfully processed. Note that processed payrolls cannot be updated.
    - `processed_date` string, nullable — The date the payroll was processed.
    - `check_date` string, nullable, required — The date on which employees will be paid for the payroll.
    - `start_date` string, nullable, required — The start date, inclusive, of the pay period.
    - `end_date` string, nullable, required — The end date, inclusive, of the pay period.
    - `totals` PayrollTotals — The overview of the payroll totals.
      - `company_debit` number, nullable — The total company debit for the payroll.
      - `tax_debit` number, nullable — The total tax debit for the payroll.
      - `check_amount` number, nullable — The total check amount for the payroll.
      - `net_pay` number, nullable — The net pay amount for the payroll.
      - `gross_pay` number, nullable — The gross pay amount for the payroll.
      - `employer_taxes` number, nullable — The total amount of employer paid taxes for the payroll.
      - `employee_taxes` number, nullable — The total amount of employee paid taxes for the payroll.
      - `employer_benefit_contributions` number, nullable — The total amount of company contributed benefits for the payroll.
      - `employee_benefit_deductions` number, nullable — The total amount of employee deducted benefits for the payroll.
    - `compensations` Compensation[] — An array of compensations for the payroll.
      - `employee_id` string, nullable, required — A unique identifier for an object.
      - `net_pay` number, nullable — The employee's net pay. Only available when payroll has been processed
      - `gross_pay` number, nullable — The employee's gross pay. Only available when payroll has been processed
      - `taxes` Tax[], nullable — An array of employer and employee taxes for the pay period.
        - `name` string, nullable — The name of the tax.
        - `employer` boolean, nullable — Paid by employer.
        - `amount` number, nullable — The amount of the tax.
      - `deductions` Deduction[], nullable — An array of employee deductions for the pay period.
        - `name` string, nullable — The name of the deduction.
        - `amount` number, nullable — The amount deducted.
      - `benefits` Benefit[], nullable — An array of employee benefits for the pay period.
        - `name` string, nullable — The name of the benefit.
        - `employee_deduction` number, nullable — The amount deducted for benefit.
        - `employer_contribution` number, nullable — The amount of employer contribution.
    - `custom_mappings` CustomMappings, nullable — When custom mappings are configured on the resource, the result is included here.
  - `meta` Meta — Response metadata
    - `items_on_page` integer — Number of items returned in the data property of the response
    - `cursors` object — Cursors to navigate to previous or next pages through the API
      - `previous` string, nullable — Cursor to navigate to the previous page of results through the API
      - `current` string, nullable — Cursor to navigate to the current page of results through the API
      - `next` string, nullable — Cursor to navigate to the next page of results through the API
    - `total_count` integer — Number of records available in total for this resource
    - `warnings` object[], nullable — Non-fatal warnings emitted when optional workflow steps failed. Present only when at least one step degraded; the response status remains 200.
      - `type` string — Discriminator for the warning kind.
      - `status_code` integer, nullable — HTTP status code returned by the failed downstream request, when available.
      - `error` string, nullable — Short error description from the downstream provider, when available.
      - `operation` string, nullable — Identifier of the workflow step that failed.
      - `message` string, nullable — Detailed message from the downstream provider, when available.
  - `_raw` Raw, nullable — Raw response from the integration when raw=true query param is provided

## Other responses

- `400` — Bad Request
- `401` — Unauthorized
- `402` — Payment Required
- `404` — The specified resource was not found
- `422` — Unprocessable
- `default` — Unexpected error

---

[API](https://skmtc.net/apideck-libraries/apis/hris-api.md) · [All operations](https://skmtc.net/apideck-libraries/apis/hris-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/apideck-libraries/hris-api/revisions/e35f311981db/schema)