IriTaxWithholdingType
stringType of tax withholding.
Allowed values:FEDERALSTATENRABACKUP
IriTaxRateToUse
stringSelected tax rate source.
Allowed values:NOWITHHOLDINGELECTEDUSEVALUESENTEREDNOWITHHOLDINGALLOWEDUSEDEFAULTTABLE
IriFilingStatus
stringTax filing status. Usually populated when default withholding tables are used.
Allowed values:SINGLEDOMESTICPARTNERSHIPDEFAULTMARRIEDHEADOFHOUSEHOLDWIDOWEDDIVORCED
IriPartyTaxWithholdingInstruction
objectImpacted party details for withholding.
Show Child Parameters
Type of tax withholding.
Allowed values:FEDERALSTATENRABACKUP
Selected tax rate source.
Allowed values:NOWITHHOLDINGELECTEDUSEVALUESENTEREDNOWITHHOLDINGALLOWEDUSEDEFAULTTABLE
Tax filing status. Usually populated when default withholding tables are used.
Allowed values:SINGLEDOMESTICPARTNERSHIPDEFAULTMARRIEDHEADOFHOUSEHOLDWIDOWEDDIVORCED
Fixed dollar amount to withhold. Mutually exclusive with percentage.
>= 0<= 9999999999.99
Example:125
Percentage rate to withhold. Mutually exclusive with dollar.
>= 0<= 100
Example:10
Requested exemptions value.
>= 0<= 99
Jurisdiction for tax purposes. Required by the IRI schema when taxWithholdingType is STATE.
<= 50 characters
Example:NC
IriPartyDeathDetails
objectDate on which the insured or annuitant died.
Example:2026-03-06
Documented reason or medical determination for death.
<= 100 characters
Example:Natural causes
Date on which the carrier was notified of the death.
Example:2026-03-07
Date the appropriate death paperwork was received.
Example:2026-03-10