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

# addW4Information

> 
The `addW4Information` API is used to collect federal tax withholding information from employees for accurate payroll tax calculation.

### What it does:

- Collects federal tax withholding data (filing status, dependents, additional withholdings)
- Enables accurate payroll tax calculations

### Note:

This is a **mandatory step** in the user onboarding flow. Federal tax information is required for all employees to ensure proper tax withholding and compliance with IRS regulations.



## OpenAPI

````yaml post /userOnboarding/addW4Information
openapi: 3.0.1
info:
  title: Default module
  description: ''
  version: 1.0.0
servers: []
security:
  - basic: []
tags: []
paths:
  /userOnboarding/addW4Information:
    post:
      tags: []
      summary: addW4Information
      description: >-

        The `addW4Information` API is used to collect federal tax withholding
        information from employees for accurate payroll tax calculation.


        ### What it does:


        - Collects federal tax withholding data (filing status, dependents,
        additional withholdings)

        - Enables accurate payroll tax calculations


        ### Note:


        This is a **mandatory step** in the user onboarding flow. Federal tax
        information is required for all employees to ensure proper tax
        withholding and compliance with IRS regulations.
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                method:
                  type: string
                  title: addW4Information
                  example: addW4Information
                w4Information:
                  type: object
                  properties:
                    userId:
                      type: string
                      title: ''
                      format: uuid
                    w4FilingStatus:
                      type: string
                      title: Enum
                      maxLength: 40
                      enum:
                        - Single
                        - Married filing jointly
                        - Head of household
                        - Married Qualifying widow(er)
                        - Married Filing Separately
                    haveMultipleJob:
                      type: boolean
                    dependents:
                      type: integer
                    dependentsAbove18:
                      type: integer
                    otherIncome:
                      type: integer
                    otherDeduction:
                      type: integer
                    extraWithholding:
                      type: integer
                    hasMiltarySpouseExemption:
                      type: boolean
                    stateAdditionalDeduction:
                      type: integer
                    isNonResident:
                      type: boolean
                    azDeductionPercent:
                      type: integer
                      title: Only added when Employee address state is Arizona
                  required:
                    - userId
                    - w4FilingStatus
                  x--orders:
                    - employeeId
                    - w4FilingStatus
                    - haveMultipleJob
                    - dependents
                    - dependentsAbove18
                    - otherIncome
                    - otherDeduction
                    - ExtraWithholding
                    - HasMiltarySpouseExemption
                    - StateAdditionalDeduction
                    - IsNonResident
                    - AZDeductionPercent
              required:
                - method
                - w4Information
              x--orders:
                - method
                - w4Information
            example:
              method: addW4Information
              w4Information:
                userId: D9363C3E-91D4-4B04-ACE4-41509B306844
                w4FilingStatus: Head of household
                haveMultipleJob: true
                dependents: 3
                dependentsAbove18: 2
                otherIncome: 1500
                otherDeduction: 150
                extraWithholding: 10
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: object
                properties:
                  w4Information:
                    type: object
                    properties:
                      userId:
                        type: string
                      status:
                        type: string
                      message:
                        type: string
                    required:
                      - userId
                      - status
                    x--orders:
                      - w4InformationId
                      - status
                      - message
                x--orders:
                  - w4Information
                required:
                  - w4Information
              example:
                w4Information:
                  userId: D9363C3E-91D4-4B04-ACE4-41509B306844
                  status: Ready
                  message: >-
                    The W4Information for jacob king has been saved
                    successfully.
          headers: {}
        '400':
          description: ''
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: array
                    items:
                      type: object
                      properties:
                        code:
                          type: integer
                        message:
                          type: string
                      required:
                        - code
                required:
                  - error
              example:
                error:
                  code: 400
                  message: EmployeeId is mandatory and cannot be empty.
          headers: {}
      deprecated: false
      security:
        - basic: []
components:
  securitySchemes:
    basic:
      type: http
      scheme: basic

````