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

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

# Arrangements

## OpenAPI definition

```yaml
openapi: 3.0.0
info:
  title: Policy Service
  version: 0.0.21
servers:
  - url: https://qa.api.zinnia.io
components:
  schemas:
    ArrangementsAttributes:
      type: object
      properties:
        arrangementId:
          type: string
        arrangementType:
          type: string
        arrangementMode:
          type: string
        paymentForm:
          type: string
        numberOfModalOccurences:
          type: string
        requestedAmount:
          type: string
        appliedAmount:
          type: string
        calculatedAmount:
          type: string
        taxableGainAmount:
          type: string
        loanType:
          type: string
        loanInterestType:
          type: string
        loanPaymentType:
          type: string
        disbursementType:
          type: string
        sourceTransferAmountType:
          type: string
        requestedPercent:
          type: string
        requestedDate:
          type: string
        effectiveDate:
          type: string
        totalChargeAmount:
          type: string
        arrStatus:
          type: string
        startDate:
          type: string
        reason:
          type: string
        nextActivityDate:
          type: string
        lastActivityDate:
          type: string
        endDate:
          type: string
        valueAdjustmentFundId:
          type: string
        valueAdjustmentCoverageId:
          type: string
        valueAdjustmentPriorAmount:
          type: string
        valueAdjustmentSegmentId:
          type: string
      required:
        - arrangementId
        - arrangementType
        - arrangementMode
        - paymentForm
        - numberOfModalOccurences
        - requestedAmount
        - appliedAmount
        - calculatedAmount
        - taxableGainAmount
        - loanType
        - loanInterestType
        - loanPaymentType
        - disbursementType
        - sourceTransferAmountType
        - requestedPercent
        - requestedDate
        - effectiveDate
        - totalChargeAmount
        - arrStatus
        - startDate
        - reason
        - nextActivityDate
        - lastActivityDate
        - endDate
        - valueAdjustmentFundId
        - valueAdjustmentCoverageId
        - valueAdjustmentPriorAmount
        - valueAdjustmentSegmentId
    TaxWithHolding:
      type: object
      properties:
        attributes:
          $ref: "#/components/schemas/TaxWithHoldingAttributes"
      required:
        - attributes
    Payment:
      type: object
      properties:
        attributes:
          $ref: "#/components/schemas/PaymentAttributes"
      required:
        - attributes
    ArrangementsFee:
      type: object
      properties:
        attributes:
          $ref: "#/components/schemas/ArrangementsFeeAttributes"
      required:
        - attributes
    ArrangementSource:
      type: object
      properties:
        attributes:
          $ref: "#/components/schemas/ArrangementSourcesAttributes"
        segments:
          type: array
          items:
            $ref: "#/components/schemas/ArrangementSegment"
      required:
        - attributes
        - segments
    ArrangementLoanSegment:
      type: object
      properties:
        attributes:
          $ref: "#/components/schemas/ArrangementLoanSegmentAttributes"
        financialActivity:
          $ref: "#/components/schemas/ArrangementLoanSegmentFinancialActivity"
      required:
        - attributes
        - financialActivity
    ArrangementsMatchSegment:
      type: object
      properties:
        attributes:
          $ref: "#/components/schemas/ArrangementsMatchSegmentAttributes"
        financialActivity:
          $ref: "#/components/schemas/MatchSegmentFinancialActivity"
      required:
        - attributes
        - financialActivity
    DeathClaim:
      type: object
      properties:
        correlationId:
          type: string
          example: 657b717b7dcf554abf9ef067
          description: The unique ID to track transaction request across all systems
        effectiveDate:
          type: string
          example: 2023-01-01
          description: Date (with pattern "yyyy-mm-dd") when the transaction was
            originally scheduled or expected to happen, can be a non-business
            day
          format: date
        reverseInitiator:
          type: boolean
          default: false
          description: A boolean flag that applies only to financial transactions. When
            set to true, it allows a backdated transaction to be processed. This
            triggers a reversal on the policy to the earliest transaction on the
            specified effective date, applies the new transaction, and then
            reprocesses all subsequent transactions (similar to (R&R) process).
            This ensures that the policy`s financial history remains accurate
            and aligned with the backdated change
        charges:
          type: array
          items:
            $ref: "#/components/schemas/Charge"
        transactionAmounts:
          $ref: "#/components/schemas/DeathClaimTransactionAmounts"
        transactionReason:
          type: string
          enum:
            - ONETIMEPREMIUM
            - GRACEPERIODPREMIUM
            - REINSTATEMENTPREMIUM
            - EXCHANGE1035
            - SURRENDER
            - AMOUNTEXCESSTOMEC
            - AMOUNTEXCESSTOGUIDELINE
            - CURRENTVALUE
            - COSTBASIS
            - GUIDELINESINGLEPREMIUM
            - GUIDELINELEVELPREMIUM
            - SEVENPAYPREMIUM
            - TOTALYTDPREMIUMAMOUNT
            - FACEDECREASECOVERAGE
            - FACEINCREASECOVERAGE
            - MECAUTHORIZATION
            - INITIALPREMIUMEXPIRATION
            - COMPLIANCE
            - STARTINGPRICE
            - LUMPSUM
            - FIVEYEARDEFERRAL
            - SPOUSALCONTINUATION
            - DISCOUNT
            - CONTROLBUSINESSINDICATOR
            - NATIONALCHANGEOFADDRESS
            - DATEOFDEATH
            - INITIALDEATHNOTIFICATION
            - PRODUCTDEFAULT
            - GWBRIDERDISBURSEMENT
            - GWBPHASECHANGE
            - PREMIUMLOAN
            - PAYMENTDUEDATE
          description: The justification or business reason for the transaction
        payeeOrBeneficiary:
          deprecated: true
          type: array
          items:
            $ref: "#/components/schemas/DeathClaimPayeeOrBeneficiary"
        parties:
          type: array
          items:
            $ref: "#/components/schemas/AdhocDisbursementParty"
        policy:
          $ref: "#/components/schemas/DeathClaimAdhocPolicy"
        externalIdentifiers:
          $ref: "#/components/schemas/AdhocExternalIdentifiers"
        payoutInformation:
          $ref: "#/components/schemas/PayoutInformation"
        taxWithholdingInstructions:
          $ref: "#/components/schemas/TaxWithholdingInstructions"
        suppression:
          type: array
          items:
            $ref: "#/components/schemas/Suppression"
    TaxWithHoldingAttributes:
      type: object
      properties:
        taxWithholdingPlace:
          type: string
        partyId:
          type: string
          description: Party ID is a unique identifier assigned to a party (individual or
            entity) involved in an insurance or annuity contract. This
            identifier helps ensure accurate data exchange and tracking across
            insurance transactions
        taxWithheldAmount:
          type: string
        taxWithheldPercent:
          type: string
        taxWithholdingType:
          type: string
        withholdingNumberExemptions:
          type: string
        maritalStatus:
          type: string
        taxJurisdiction:
          type: string
        taxableAmount:
          type: string
      required:
        - taxWithholdingPlace
        - partyId
        - taxWithheldAmount
        - taxWithheldPercent
        - taxWithholdingType
        - withholdingNumberExemptions
        - maritalStatus
        - taxJurisdiction
        - taxableAmount
    PaymentAttributes:
      type: object
      properties:
        partyRole:
          type: string
        partyId:
          type: string
          description: Party ID is a unique identifier assigned to a party (individual or
            entity) involved in an insurance or annuity contract. This
            identifier helps ensure accurate data exchange and tracking across
            insurance transactions
        bankId:
          type: string
        allocationPercent:
          type: string
        paymentAmount:
          type: string
      required:
        - partyRole
        - partyId
        - bankId
        - allocationPercent
        - paymentAmount
    ArrangementsFeeAttributes:
      type: object
      properties:
        feeType:
          type: string
        feeAmount:
          type: string
        startDate:
          type: string
        effectiveRate:
          type: string
        feeWaivedIndicator:
          type: string
      required:
        - feeType
        - feeAmount
        - startDate
        - effectiveRate
        - feeWaivedIndicator
    ArrangementSourcesAttributes:
      type: object
      properties:
        fundId:
          type: string
        transferAmount:
          type: string
        transferPercent:
          type: string
      required:
        - fundId
        - transferAmount
        - transferPercent
    ArrangementSegment:
      type: object
      properties:
        attributes:
          $ref: "#/components/schemas/ArrangementSegmentAttributes"
        financialActivity:
          $ref: "#/components/schemas/ArrangementFinancialActivity"
      required:
        - attributes
        - financialActivity
    ArrangementLoanSegmentAttributes:
      type: object
      properties:
        segmentId:
          type: string
        requestedAmount:
          type: string
      required:
        - segmentId
        - requestedAmount
    ArrangementLoanSegmentFinancialActivity:
      type: object
      properties:
        attributes:
          $ref: "#/components/schemas/ArrangementLoanSegmentFinancialActivityAttributes"
      required:
        - attributes
    ArrangementsMatchSegmentAttributes:
      type: object
      properties:
        segmentId:
          type: string
        requestedAmount:
          type: string
      required:
        - segmentId
        - requestedAmount
    MatchSegmentFinancialActivity:
      type: object
      properties:
        attributes:
          $ref: "#/components/schemas/MatchSegmentFinancialActivityAttributes"
      required:
        - attributes
    Charge:
      type: object
      properties:
        chargeType:
          $ref: "#/components/schemas/TransactionChargeType"
        chargeWaiverIndicator:
          $ref: "#/components/schemas/ChargeWaiverIndicator"
        chargeWaiverReason:
          type: string
          description: The reason why a charge was waived (e.g., Promotional Waiver,
            Policy Exception)
          example: "100"
        partyId:
          type: string
          description: The partyId to which the charge is applied.
          example: Party_PI_1
    DeathClaimTransactionAmounts:
      type: object
      properties:
        claimStatutoryInterestAmount:
          type: number
          example: 90
          description: The statutory interest amount paid as part of a claim settlement.
            This is the SSI amount
          format: double
        deathBenefitInterestCalculatedFromDate:
          $ref: "#/components/schemas/DeathBenefitInterestCalculatedFromDate"
        claimStatutoryInterestRate:
          type: number
          example: 10
          format: double
          description: The state specific interest rate applied to the statutory claim
            payout
        distributionCode:
          $ref: "#/components/schemas/DistributionCode"
        accountNumber:
          type: string
          example: "123456789"
          description: The unique identifier representing the policy or account associated
            with the transaction for DTCC money movement.
        participantId:
          type: string
          example: DTCC12345
          description: The DTCC Participant ID (also known as DTCC Number or Participant
            Number) assigned by DTCC to financial institutions.
    DeathClaimPayeeOrBeneficiary:
      type: object
      properties:
        partyId:
          type: string
          description: A unique identifier linking the party to the policy
          example: Party_PI_1
        paymentForm:
          $ref: "#/components/schemas/PaymentForm"
        allocationPercentage:
          type: number
          description: The percentage of the total disbursement allocated to the payee
          example: 100
          format: double
        bankId:
          type: string
          example: Bank_1
          description: A unique identifier for the financial institution handling the
            transaction
        partyRole:
          $ref: "#/components/schemas/PartyRole"
      required:
        - allocationPercentage
    AdhocDisbursementParty:
      type: object
      properties:
        partyRole:
          $ref: "#/components/schemas/PartyRole"
        partyId:
          type: string
          description: unique identifier linking the party to the policy
          example: Party_PI_1
        paymentForm:
          $ref: "#/components/schemas/PaymentForm"
        allocationPercentage:
          type: number
          description: The percentage of the total disbursement allocated to the payee
          example: 100
          format: double
        bankId:
          type: string
          description: A unique identifier for the financial institution handling the
            transaction
          example: Bank_1
        addressId:
          type: string
          description: A unique identifier for the address associated with the payee or
            policyholder
          example: "1"
        forBenefitOfOrForFurtherCredit:
          type: string
          description: FBO - For Benefit Of, FFC - For Further Credit. (To notate a second
            beneficiary or to designate a person or organization when funds are
            disbursed out)
          example: John Doe
        forBenefitOfOrForFurtherCreditIndicator:
          type: boolean
          example: true
          description: Indicates whether the outgoing funds are being requested for the
            benefit of or for further credit to another person or organization.
    DeathClaimAdhocPolicy:
      type: object
      properties:
        policyDates:
          $ref: "#/components/schemas/DeathClaimAdhocPolicyDates"
        deathBenefit:
          $ref: "#/components/schemas/DeathClaimAdhocDeathBenefit"
        party:
          $ref: "#/components/schemas/DeathClaimAdhocParty"
        charges:
          $ref: "#/components/schemas/Charge"
    AdhocExternalIdentifiers:
      type: object
      properties:
        referenceNumber:
          type: string
          description: The unique payment reference number for all premium-related
        externalTransactionId:
          type: string
          description: The unique ID to identify transaction on carrier side
    PayoutInformation:
      type: object
      properties:
        payoutType:
          $ref: "#/components/schemas/PayoutType"
    TaxWithholdingInstructions:
      type: object
      properties:
        partyId:
          type: string
          description: A unique identifier linking the party to the policy
          example: Party_PI_1
        partyRole:
          type: string
          enum:
            - OWNER
            - PRIMARYBENEFICIARY
            - CONTINGENTBENEFICIARY
            - INSURED
            - PAYOR
            - PAYEE
            - AGENT
            - PRIMARYWRITINGAGENT
            - PRIMARYSERVICINGAGENT
            - ADDITIONALSERVICINGAGENT
            - ADDITIONALWRITINGAGENT
            - THIRDPARTYDESIGNEE
            - JOINTOWNER
            - COVERAGEINSURED
            - ASSIGNEE
            - ANNUITANT
            - EXCHANGECOMPANY
            - JOINTANNUITANT
            - GRANTOR
            - TRUSTEE
            - POWEROFATTORNEY
            - AUTHORIZEDSIGNATORY
            - OTHERINTERESTEDPARTY
            - CONTINGENTOWNER
            - THIRDPARTYADMINISTRATOR
            - CARRIER
            - SUCCESSORTRUSTEE
            - COVERAGEJOINTINSURED
          description: Roles that are essential in structuring life insurance and annuity
            contracts to meet the financial goals of policyholders and
            beneficiaries
        taxWithholdingType:
          $ref: "#/components/schemas/TaxWithholdingType"
        taxRateToUse:
          $ref: "#/components/schemas/TaxRateToUse"
        filingStatus:
          $ref: "#/components/schemas/FilingStatus"
        dollar:
          type: number
          description: The amount portion of the taxable transaction amount to be withheld
          example: 10
          format: double
        percentage:
          type: number
          description: The percentage of the taxable transaction amount to be withheld
          example: 50
          format: double
        exemptions:
          type: number
          description: The number of exemptions claimed for tax withholding within a tax
            year
          example: 0
          format: int32
        taxJurisdiction:
          type: string
          description: The legal tax authority (state or federal) governing the
            withholding process
          example: USA_WY
        contribution:
          type: string
          enum:
            - NOTAPPLICABLE
            - EMPLOYEEVOLUNTARY
            - EMPLOYEEDISCRETIONARY
          description: Not applicable, Employee Voluntary and Employee Discretionary
        taxFormType:
          type: string
          enum:
            - T1035COSTBASIS
            - T1035LOANTRANSFER
            - T1035SURRENDER
            - T1035TAXADVANTAGE
            - T1099R
            - TAXDISCLOSUREFORMW4P
            - TAXDISCLOSUREFORMW8
            - USW4TAXFORM
            - W9
            - VOIDCHECK
          description: The Tax Form Type refers to the specific IRS or government form
            used as the basis for determining an individual’s or entity’s tax
            withholding status on financial products such as life insurance
            policies, annuities, or investment accounts
        w4p:
          $ref: "#/components/schemas/W4P"
    Suppression:
      type: object
      properties:
        suppressionType:
          $ref: "#/components/schemas/SuppressionType"
        suppressionReason:
          type: string
          description: Specifies the specific reason or justification for applying the
            suppression. It explains why the suppression was applied.
    ArrangementSegmentAttributes:
      type: object
      properties:
        segmentId:
          type: string
        requestedAmount:
          type: string
      required:
        - segmentId
        - requestedAmount
    ArrangementFinancialActivity:
      type: object
      properties:
        attributes:
          $ref: "#/components/schemas/ArrangementFinancialActivityAttributes"
      required:
        - attributes
    ArrangementLoanSegmentFinancialActivityAttributes:
      type: object
      properties:
        interestPostingRate:
          type: string
        amount:
          type: string
      required:
        - interestPostingRate
        - amount
    MatchSegmentFinancialActivityAttributes:
      type: object
      properties:
        interestPostingRate:
          type: string
        amount:
          type: string
      required:
        - interestPostingRate
        - amount
    TransactionChargeType:
      type: string
      enum:
        - COSTOFINSURANCE
        - EXPENSECHARGE
        - UNITEXPENSECHARGE
        - RIDERCHARGE
        - SURRENDERCHARGE
        - WITHDRAWALCHARGE
        - PAYMENTCHARGE
        - COVERAGECHARGE
        - COVERAGECREDIT
        - PREMIUMTAX
        - MARKETVALUEADJUSTMENT
        - BONUSRECAPTURE
        - EQUITYINDEXADJUSTMENT
        - PRODUCTLIMITS
        - DEATHBENEFITINTEREST
        - FUTURECHARGESFORTRANSACTION
        - REDEMPTIONFEE
        - MAILCHARGE
        - FUNDFEE
        - INEFFECT
        - ALL
        - OVERNIGHTMAIL
        - WIRE
    ChargeWaiverIndicator:
      type: string
      enum:
        - Yes
        - No
    DeathBenefitInterestCalculatedFromDate:
      type: string
      enum:
        - DATEOFDEATH
        - DATEOFDEATHREPORTED
    DistributionCode:
      type: string
      enum:
        - DEFAULT
        - PREMATUREDISTRIBUTION
        - EXCEPTIONAPPLIES
        - DISABILITY
        - DEATH
        - DEATHEXCLUSION
        - DEATHROLLOVER
        - EXCHANGE1035
        - NORMALDISTRIBUTION
        - COSTOFCURRENTLIFEINSURANCEPROTECTION
        - QUALIFIEDROLLOVER
        - ROTHDISTRIBUTIONNOEXCEPTION
        - QUALIFIEDLOANDISTRIBUTION
        - PREMATURELOANDISTRIBUTION
        - QUALIFIEDROTHINDIVIDUALRETIREMENTARRANGEMENTDISTRIBUTION
        - ROTHINDIVIDUALRETIREMENTACCOUNTSDISTRIBUTIONEXCEPTIONAPPLIES
        - EXCESSCONTRIBUTIONSPLUSEARNINGSEXCESSDEFERRALSTAXABLEIN2009
        - NONTAXABLEEVENT
        - GROSSPAIDTOATTORNEY
        - OTHERINCOME
        - NONEMPLOYEECOMPENSATION
        - PREMATUREEXCEPTION
        - ROYALTIES
        - DEATHTRANSFER4H
        - PROHIBITEDTRANSACTION
        - TENYEARTAXOPTION
        - TRUSTEETOTRUSTEETRANSFER
        - QUALIFIEDDOMESTICRELATIONSORDERLIKETOLIKENO1099
        - DISTRIBUTIONSUNDEREMPLOYEEPLANSCOMPLIANCERESOLUTIONSYSTEM
        - CHARITABLEGIFT
        - LOANSASDISTRIBUTIONS
        - QUALIFIEDPLANLOANOFFSET
        - RECHARACTERIZEDINDIVIDUALRETIREMENTARRANGEMENTCURRENTYEAR
        - EXCESSCONTRIBUTION1YEARPRIORTAX
        - RECHARACTERIZEDINDIVIDUALRETIREMENTACCOUNTSPREVIOUSYEAR
        - EARLYDISTRIBUTIONFROMSAVINGSINCENTIVEMATCHPLANFOREMPLOYEES
        - DIRECTTRANSFER
        - EXCESSCONTRIBUTIONSPLUSEARNINGSEXCESSDEFERRALSANDOREARNINGSTAXABLEIN2024
        - EXCESSCONTRIBUTIONS2YEARPRIORTAX
        - DIRECTROLLOVERQUALPLANTAXSHELTEREDANNUITY
        - SEPARATIONFROMSERVICE
        - INDIVIDUALRETIREMENTARRANGEMENTTOROTHINDIVIDUALRETIREMENTARRANGEMENT
        - QUALIFIEDDOMESTICRELATIONSORDERROLLOVERTOINDIVIDUALRETIREMENTARRANGEMENT2G
        - QUALIFIEDDOMESTICRELATIONSORDERPAYMENTTOSPOUSE
        - FIRSTTIMEHOMEBUYERINDIVIDUALRETIREMENTARRANGEMENTONLY
        - EDUCATIONEXPENSE
        - MEDICALEXPENSE
        - FEEADMIN
        - FEEASSET
        - FEECONTRIBUTION
        - FEELUMPSUMDEATH
        - FEELUMPSUMDISABILITY
        - FEELUMPSUMPURCHASEDANNUITY
        - FEELUMPSUMOTHER
        - FEENEWRETIREEWITHPERPAYMENT
        - FEEEXISTINGRETIREMENTINFORCE
        - FEECONTRACT
        - FEEEXISTINGRETIREMENTINCREASE
        - FEETHIRDPARTY
        - LUMPSUMDEATH
        - LUMPSUMDISABILITY
        - LUMPSUMPURCHASEDANNUITY
        - LUMPSUMOTHER
        - FEEINTERNATIONALPROGRAMSGROUPEXPENSE
        - FROMFUND
        - RELEASERESERVE
        - HEALTHDEDUCTION
        - FEEMARKETVALUE
        - FEEANNUITYADMINISTRATION
        - SECTION1035EXCHANGEPARTIAL
        - QUALIFIEDDOMESTICRELATIONSORDERNORMALDISTRIBUTION
        - QUALIFIEDDOMESTICRELATIONSORDERSECTION1035
        - FEELONGTERMCAREINSURANCE
        - DESIGNATEDROTHACCOUNTDISTRIBUTION
        - REPORTABLEDEATHBENEFITSUNDERSECTION6050Y
        - DISTRIBUTIONOFTRADITIONALINDIVIDUALRETIREMENTARRANGEMENTASSETSNOTHAVINGAREADILYAVAILABLEFAIRMARKETVALUE
        - DIVIDENDSDISTRIBUTEDFROMANEMPLOYEESTOCKOWNERSHIPPLANSUNDERSECTION404K
        - DIRECTROLLOVEROFADESIGNATEDROTHACCOUNT
        - DEATHQUALIFIEDCHARITABLEDISTRIBUTION
        - NORMALQUALIFIEDCHARITABLEDISTRIBUTION
    PaymentForm:
      type: string
      enum:
        - DTCC
        - CREDITCARD
        - ACH
        - CHECK
        - WIRE
        - EXCHANGE
        - PREMIUMLOAN
    PartyRole:
      type: string
      enum:
        - OWNER
        - PRIMARYBENEFICIARY
        - CONTINGENTBENEFICIARY
        - INSURED
        - PAYOR
        - PAYEE
        - AGENT
        - PRIMARYWRITINGAGENT
        - PRIMARYSERVICINGAGENT
        - ADDITIONALSERVICINGAGENT
        - ADDITIONALWRITINGAGENT
        - THIRDPARTYDESIGNEE
        - JOINTOWNER
        - COVERAGEINSURED
        - ASSIGNEE
        - ANNUITANT
        - EXCHANGECOMPANY
        - JOINTANNUITANT
        - GRANTOR
        - TRUSTEE
        - POWEROFATTORNEY
        - AUTHORIZEDSIGNATORY
        - OTHERINTERESTEDPARTY
        - CONTINGENTOWNER
        - THIRDPARTYADMINISTRATOR
        - CARRIER
        - SUCCESSORTRUSTEE
        - COVERAGEJOINTINSURED
    DeathClaimAdhocPolicyDates:
      type: object
      properties:
        claimApprovalDate:
          type: string
          example: 2024-02-21
          format: date
          description: The Claim Approval Date is the date when an insurance company
            officially approves a claim for payment after verifying the claim
            details, policy coverage, and required documentation
        certifiedReceivedDate:
          type: string
          example: 2024-02-21
          format: date
          description: The Certified Received Date refers to the date when the insurance
            company officially receives the certified death paperwork (such as a
            death certificate) required to process a life insurance claim. This
            date marks the beginning of the formal claims verification process
    DeathClaimAdhocDeathBenefit:
      type: object
      properties:
        claimStatus:
          $ref: "#/components/schemas/ClaimStatus"
        proofOfDeathReceived:
          type: boolean
          description: Whether proof of death is received
    DeathClaimAdhocParty:
      type: object
      properties:
        beneficiaryPercentage:
          type: number
          example: 100
          format: double
          description: The benefit percentage of the beneficiary
        partyStatus:
          $ref: "#/components/schemas/PartyStatus"
    PayoutType:
      type: string
      enum:
        - LUMPSUM
        - FIVEYEARDEFERRAL
        - SPOUSALCONTINUATION
    TaxWithholdingType:
      type: string
      enum:
        - FEDERAL
        - STATE
        - NRA
        - BACKUP
    TaxRateToUse:
      type: string
      enum:
        - NOWITHHOLDINGELECTED
        - USEVALUESENTERED
        - NOWITHHOLDINGALLOWED
        - USEDEFAULTTABLE
        - ADDITIONALWITHHOLDING
        - TAKEINPUTTEDVALUE
    FilingStatus:
      type: string
      enum:
        - SINGLE
        - DOMESTICPARTNERSHIP
        - DEFAULT
        - MARRIED
        - HEADOFHOUSEHOLD
        - WIDOWED
        - DIVORCED
        - MARRIEDFILINGSEPARATELY
    W4P:
      type: object
      properties:
        totalAmountOfOtherIncomeAndOtherPensionsOrAnnuities:
          type: number
          format: double
          example: 12.12
          description: "Below Amounts are for periodic Payments Only  - Certain States
            Require these amounts to be entered "
        totalAmountOfClaimsAndOtherCredits:
          type: number
          format: double
          example: 213.73
          description: "This indicates the total amount of tax claims and credits party is
            eligible for to reduce the tax liabilities "
        otherIncome:
          type: number
          format: double
          example: 144.53
          description: "Not from Jobs or Pension/Annuities "
        otherDeduction:
          type: number
          format: double
          example: 42.83
          description: If Standard Deduction is not used
    SuppressionType:
      type: string
      description: Specifies the category or type of suppression being applied to a
        transaction. It indicates what kind of suppression is in effect.
      enum:
        - CORRESPONDENCE
        - TAX
        - DISBURSEMENT
        - COMMISSION
    ArrangementFinancialActivityAttributes:
      type: object
      properties:
        interestPostingRate:
          type: string
        amount:
          type: string
      required:
        - interestPostingRate
        - amount
    ClaimStatus:
      type: string
      enum:
        - APPROVED
        - NOTAPPROVED
        - PROCESSED
    PartyStatus:
      type: string
      enum:
        - APPROVED
        - NOTAPPROVED
        - PROCESSED
    Arrangements:
      type: object
      properties:
        attributes:
          $ref: "#/components/schemas/ArrangementsAttributes"
        taxWithHolding:
          type: array
          items:
            $ref: "#/components/schemas/TaxWithHolding"
        payments:
          type: array
          items:
            $ref: "#/components/schemas/Payment"
        fees:
          type: array
          items:
            $ref: "#/components/schemas/ArrangementsFee"
        arrangementSources:
          type: array
          items:
            $ref: "#/components/schemas/ArrangementSource"
        loanSegments:
          type: array
          items:
            $ref: "#/components/schemas/ArrangementLoanSegment"
        matchSegment:
          $ref: "#/components/schemas/ArrangementsMatchSegment"
        deathClaim:
          $ref: "#/components/schemas/DeathClaim"
      required:
        - attributes
        - taxWithHolding
        - payments
        - fees
        - arrangementSources
        - loanSegments
        - matchSegment
        - deathClaim
```