> ## Documentation Index
> Fetch the complete documentation index at: https://docs.bindbee.dev/llms.txt
> Use this file to discover all available pages before exploring further.

# Get Employee Payroll Runs By Id

> Returns an EmployeePayrollRun object with the given id



## OpenAPI

````yaml get /api/hris/v1/employee-payroll-runs/{id}
openapi: 3.1.0
info:
  title: Bindbee APIs
  version: 0.1.0
servers:
  - url: https://api.bindbee.dev
  - url: https://api-eu.bindbee.dev
security: []
paths:
  /api/hris/v1/employee-payroll-runs/{id}:
    get:
      tags:
        - Employee Payroll Runs
      summary: Get Employee Payroll Runs By Id
      description: Returns an EmployeePayrollRun object with the given id
      operationId: >-
        get_employee_payroll_runs_by_id_api_hris_v1_employee_payroll_runs__id__get
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
            format: uuid
            title: Id
        - name: include_raw_data
          in: query
          required: false
          schema:
            type: boolean
            description: >-
              Whether to include the original data Bindbee fetched from the
              third-party to produce these models.
            examples:
              - false
            default: false
            title: Include Raw Data
          description: >-
            Whether to include the original data Bindbee fetched from the
            third-party to produce these models.
        - name: include_custom_fields
          in: query
          required: false
          schema:
            type: boolean
            description: Whether to include custom fields in the response.
            examples:
              - false
            default: false
            title: Include Custom Fields
          description: Whether to include custom fields in the response.
        - name: expand
          in: query
          required: false
          schema:
            type: string
            description: >-
              Which relations should be returned in expanded form. Multiple
              relation names should be comma separated without spaces. You can
              also specify required fields in [] for each relation name.
            examples:
              - manager[first_name,last_name]
            title: Expand
          description: >-
            Which relations should be returned in expanded form. Multiple
            relation names should be comma separated without spaces. You can
            also specify required fields in [] for each relation name.
        - name: x-connector-token
          in: header
          required: true
          schema:
            type: string
            title: X-Connector-Token
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HrisEmployeePayrollRun'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
        - HTTPBearer: []
components:
  schemas:
    HrisEmployeePayrollRun:
      properties:
        id:
          type: string
          format: uuid
          title: Id
          examples:
            - 018b18ef-c487-703c-afd9-0ca478ccd9d6
        remote_id:
          anyOf:
            - type: string
            - type: 'null'
          title: Remote Id
          description: The third-party API ID of the matching object.
          examples:
            - '123321'
        modified_at:
          type: string
          title: Modified At
          description: This is the datetime that this object was last updated by Bindbee
          examples:
            - '2021-10-16T00:00:00Z'
        raw_data:
          anyOf:
            - additionalProperties: true
              type: object
            - type: 'null'
          title: Raw Data
          description: This is the Raw data
          examples:
            - key_1: Platform dependent data 1
              key_2: Platform dependent data 2
        custom_fields:
          anyOf:
            - additionalProperties: true
              type: object
            - type: 'null'
          title: Custom Fields
          description: The custom fields related to the model
          examples:
            - category_group: REG
              disability_type: ASBERG
              hire_date: '1991-03-16T00:00:00'
              hire_source: REFER
              nationality: USA
              original_hire_date: '1991-03-16T00:00:00'
        employee:
          anyOf:
            - {}
            - type: 'null'
          title: Employee
          description: The employee whose payroll is being run.
          examples:
            - 018b168d-70f9-7043-a796-56d66a4f8f07
        payroll_run:
          anyOf:
            - {}
            - type: 'null'
          title: Payroll Run
          description: The payroll being run.
          examples:
            - 018b709e-b6ef-7db4-902a-a064157bdba2
        gross_pay:
          anyOf:
            - type: number
            - type: integer
            - type: 'null'
          title: Gross Pay
          description: >-
            The total earnings throughout a given period for an employee before
            any deductions are made.
          examples:
            - 772277.77
        net_pay:
          anyOf:
            - type: number
            - type: integer
            - type: 'null'
          title: Net Pay
          description: >-
            The take-home pay throughout a given period for an employee after
            deductions are made.
          examples:
            - 577221.27
        start_date:
          anyOf:
            - type: string
            - type: 'null'
          title: Start Date
          description: The day and time the benefit started.
          examples:
            - '2023-07-01T00:00:00Z'
        end_date:
          anyOf:
            - type: string
            - type: 'null'
          title: End Date
          description: The day and time the benefit ended.
          examples:
            - '2023-07-31T00:00:00Z'
        check_date:
          anyOf:
            - type: string
            - type: 'null'
          title: Check Date
          description: The day and time the payroll run was checked.
          examples:
            - '2023-08-31T00:00:00Z'
        earnings:
          anyOf:
            - items:
                $ref: '#/components/schemas/Earning'
              type: array
            - type: 'null'
          title: Earnings
          description: The earnings of the Employee
          examples:
            - amount: '27151'
              name: SALARY
        deductions:
          anyOf:
            - items:
                $ref: '#/components/schemas/Deduction'
              type: array
            - type: 'null'
          title: Deductions
          description: The deductions of the Employee
          examples:
            - company_deduction: '77.57'
              employee_deduction: '27.22'
              name: Social Security
        taxes:
          anyOf:
            - items:
                $ref: '#/components/schemas/Tax'
              type: array
            - type: 'null'
          title: Taxes
          description: The taxes of the Employee
          examples:
            - amount: '175.22'
              name: California State Income Tax
      type: object
      required:
        - id
        - remote_id
        - modified_at
        - custom_fields
        - employee
        - payroll_run
        - gross_pay
        - net_pay
        - start_date
        - end_date
        - check_date
        - earnings
        - deductions
        - taxes
      title: HrisEmployeePayrollRun
      description: >-
        The EmployeePayrollRun object is used to represent an employee's pay
        statement for a specific payroll run.
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    Earning:
      properties:
        amount:
          anyOf:
            - type: integer
            - type: number
            - type: 'null'
          title: Amount
          description: The amount earned.
          examples:
            - '27151'
        name:
          anyOf:
            - type: string
            - type: 'null'
          enum:
            - SALARY
            - REIMBURSEMENT
            - OVERTIME
            - BONUS
            - HOURLY
          title: Name
          description: >-
            The type of earning. If the value is not one of the defined enum
            values, the original value passed through will be returned.
          examples:
            - SALARY
      type: object
      required:
        - amount
        - name
      title: Earning
    Deduction:
      properties:
        name:
          anyOf:
            - type: string
            - type: 'null'
          title: Name
          description: The deduction's name.
          examples:
            - Social Security
        employee_deduction:
          anyOf:
            - type: integer
            - type: number
            - type: 'null'
          title: Employee Deduction
          description: >-
            The amount of money that is withheld from an employee's gross pay by
            the employee.
          examples:
            - 27.22
        company_deduction:
          anyOf:
            - type: integer
            - type: number
            - type: 'null'
          title: Company Deduction
          description: >-
            The amount of money that is withheld on behalf of an employee by the
            company.
          examples:
            - 77.57
      type: object
      required:
        - name
        - employee_deduction
        - company_deduction
      title: Deduction
    Tax:
      properties:
        name:
          anyOf:
            - type: string
            - type: 'null'
          title: Name
          description: The tax's name.
          examples:
            - California State Income Tax
        amount:
          anyOf:
            - type: integer
            - type: number
            - type: 'null'
          title: Amount
          description: The tax amount.
          examples:
            - 175.22
      type: object
      required:
        - name
        - amount
      title: Tax
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError
  securitySchemes:
    HTTPBearer:
      type: http
      scheme: bearer

````