---
title: "IriPartyTaxWithholdingInstruction"
url: "https://developers.zinnia.com/apis/policy-service-0-1-0/versions/8306e031-b41c-452a-a7ed-d73d65602086/schemas/IriPartyTaxWithholdingInstruction"
---

> Full API specification: https://developers.zinnia.com/apis/policy-service-0-1-0/versions/8306e031-b41c-452a-a7ed-d73d65602086.md

# IriPartyTaxWithholdingInstruction

## OpenAPI definition

```yaml
openapi: 3.0.0
info:
  title: Policy Service
  version: 0.0.21
servers:
  - url: https://uat.api.zinnia.io
components:
  schemas:
    IriPartyTaxWithholdingParty:
      type: object
      properties:
        type:
          $ref: "#/components/schemas/IriPartyType"
        firstName:
          type: string
          description: First name of the individual party.
          example: John
          minLength: 1
          maxLength: 100
        middleName:
          type: string
          description: Middle name of the individual party.
          example: Q
          minLength: 1
          maxLength: 100
        lastName:
          type: string
          description: Last name of the individual party.
          example: Public
          minLength: 1
          maxLength: 100
        name:
          type: string
          description: Entity name of the party.
          example: Public Family Trust
          minLength: 1
          maxLength: 100
        taxId:
          type: string
          description: Tax identification number for the party.
          example: "123456789"
          minLength: 9
          maxLength: 9
          pattern: ^[0-9]{9}$
      required:
        - type
        - taxId
    IriTaxWithholdingType:
      type: string
      description: Type of tax withholding.
      enum:
        - FEDERAL
        - STATE
        - NRA
        - BACKUP
    IriTaxRateToUse:
      type: string
      description: Selected tax rate source.
      enum:
        - NOWITHHOLDINGELECTED
        - USEVALUESENTERED
        - NOWITHHOLDINGALLOWED
        - USEDEFAULTTABLE
    IriFilingStatus:
      type: string
      description: Tax filing status. Usually populated when default withholding
        tables are used.
      enum:
        - SINGLE
        - DOMESTICPARTNERSHIP
        - DEFAULT
        - MARRIED
        - HEADOFHOUSEHOLD
        - WIDOWED
        - DIVORCED
    IriPartyType:
      type: string
      description: Type of party.
      enum:
        - individual
        - entity
    IriPartyTaxWithholdingInstruction:
      type: object
      properties:
        party:
          description: Impacted party details for withholding.
          allOf:
            - $ref: "#/components/schemas/IriPartyTaxWithholdingParty"
        taxWithholdingType:
          $ref: "#/components/schemas/IriTaxWithholdingType"
        taxRateToUse:
          $ref: "#/components/schemas/IriTaxRateToUse"
        filingStatus:
          $ref: "#/components/schemas/IriFilingStatus"
        dollar:
          type: number
          description: Fixed dollar amount to withhold. Mutually exclusive with percentage.
          example: 125
          minimum: 0
          maximum: 9999999999.99
        percentage:
          type: number
          description: Percentage rate to withhold. Mutually exclusive with dollar.
          example: 10
          minimum: 0
          maximum: 100
        exemptions:
          type: number
          description: Requested exemptions value.
          example: 0
          minimum: 0
          maximum: 99
        taxJurisdiction:
          type: string
          description: Jurisdiction for tax purposes. Required by the IRI schema when
            taxWithholdingType is STATE.
          example: NC
          maxLength: 50
      required:
        - taxWithholdingType
        - taxRateToUse
```