---
title: "Withholding"
url: "https://developers.zinnia.com/apis/new-business-annuity/versions/45a989ab-c3aa-4f85-8f67-f05c41747ed7/schemas/Withholding"
---

> Full API specification: https://developers.zinnia.com/apis/new-business-annuity/versions/45a989ab-c3aa-4f85-8f67-f05c41747ed7.md

# Withholding

## OpenAPI definition

```yaml
openapi: 3.1.0
info:
  title: Zinnia New Business Annuity API
  version: 0.6.0
servers:
  - url: https://qa.api.zinnia.io
    description: QA Environment
  - url: https://dev.api.zinnia.io
    description: DEV Environment
  - url: https://uat.api.zinnia.io
    description: UAT Environment
  - url: https://api.zinnia.io
    description: PROD Environment
components:
  schemas:
    Withholding:
      type: object
      required:
        - withholdingAmount
        - withholdingAmountQualifer
        - withholdingAuthority
      properties:
        withholdingAmount:
          type: number
          format: double
          description: The amount to be withheld if withholding is selected
          example: 100.5
        withholdingAmountQualifer:
          type: string
          description: Qualifies the withholding amount. Either as dollars or a percentage
          enum:
            - DOLLAR
            - PERCENT
          example: DOLLAR
        withholdingAmountType:
          type: string
          description: This will be used to indicate the type of withholding information
            for this instance of the Withholding Amount.  This is in reference
            to the IRS W-4P and W-4R tax withholding forms
          enum:
            - JOBORPEN
            - EXTRA
            - OTHRDED
            - OTHRINC
            - CLMSNCRED
            - DEFAULT
            - NOWITH
            - USEVALUES
          example: JOBORPEN
        withholdingAuthority:
          type: string
          description: Defines the withholding authority for which is being withheld
          enum:
            - ST
            - FED
            - LOCAL
            - NRA
            - BACKUP
          example: FED
```