NexumAPI Docs
NexumAPI Docs
  • Introduction
  • Authentication
  • Quickstart
  • NaaS Endpoints
  • Capabilities
  • Changelog
  • Links
    • NexumAPI
    • GitHub
  • Resources
    • Symitar Playground
    • Help & Feedback
  • SymXchange
    • API Reference
      • Persistent
        • AccountService
          • Account
          • BatchAchOrig
          • Card
            • createCard
            • deleteCard
            • getCard
            • searchCard
            • updateCard
          • Comment
          • CpWorkCard
          • CredRep
          • Eft
            • createEft
            • deleteEft
            • getEft
            • searchEft
            • updateEft
          • ExternalAccount
          • ExternalLoan
            • createExternalLoan
            • deleteExternalLoan
            • getExternalLoan
            • searchExternalLoan
            • updateExternalLoan
          • FmHistoryPagedList
          • Household
          • Irs
            • createIrs
            • deleteIrs
            • getIrs
            • searchIrs
            • updateIrs
          • Loan
            • createLoan
            • deleteLoan
            • getLoan
            • searchLoan
            • updateLoan
          • LoanApp
            • createLoanApp
            • deleteLoanApp
            • getLoanApp
            • searchLoanApp
            • updateLoanApp
          • Lookup
          • Name
          • Note
          • Pledge
          • Portfolio
            • createPortfolio
            • deletePortfolio
            • getPortfolio
            • searchPortfolio
            • updatePortfolio
          • Preference
          • Share
            • createShare
            • deleteShare
            • getShare
            • searchShare
            • updateShare
          • Site
          • Tracking
        • AccountsPayableService
        • BalancingService
        • BatchJobsService
        • CashLetterService
        • CheckService
        • CheckVerificationService
        • CollateralService
        • ContactEventMgmtService
        • CorpTransferService
        • CreditReportService
        • DealerService
        • EcaaService
        • ExceptionItemService
        • FileManagementService
        • FindByService
        • FinrepService
        • GeneralLedgerService
        • InformationService
        • InventoryService
        • MbraddressService
        • MemberService
        • NonAccountNameService
        • ParticipantService
        • PayeeService
        • PowerOnService
        • ProjectionService
        • ReceivedItemService
        • RemittanceService
        • TransactionsService
        • UserManagementService
        • UserService
        • WireService
          • Wire
          • WireBeneficiary
            • createWireBeneficiary
            • deleteWireBeneficiary
            • getWireBeneficiary
            • searchWireBeneficiary
            • updateWireBeneficiary
          • WireDrawdownDebit
          • WireFiToFiInfo
          • WireFmHistory
          • WireIntermedFi
          • WireOfacDetails
          • WireReceiverFiInfo
          • WireServiceMessage
          • WireUscAudit
      • v2022.01
        • AccountService
          • Account
          • BatchAchOrig
          • Card
            • createCard
            • deleteCard
            • getCard
            • searchCard
            • updateCard
          • Comment
          • CpWorkCard
          • CredRep
          • Eft
            • createEft
            • deleteEft
            • getEft
            • searchEft
            • updateEft
          • ExternalAccount
          • ExternalLoan
            • createExternalLoan
            • deleteExternalLoan
            • getExternalLoan
            • searchExternalLoan
            • updateExternalLoan
          • FmHistoryPagedList
          • Household
          • Irs
            • createIrs
            • deleteIrs
            • getIrs
            • searchIrs
            • updateIrs
          • Loan
            • createLoan
            • deleteLoan
            • getLoan
            • searchLoan
            • updateLoan
          • LoanApp
            • createLoanApp
            • deleteLoanApp
            • getLoanApp
            • searchLoanApp
            • updateLoanApp
          • Lookup
          • Name
          • Note
          • Pledge
          • Portfolio
            • createPortfolio
            • deletePortfolio
            • getPortfolio
            • searchPortfolio
            • updatePortfolio
          • Preference
          • Share
            • createShare
            • deleteShare
            • getShare
            • searchShare
            • updateShare
          • Site
          • Tracking
        • AccountsPayableService
        • BalancingService
        • BatchJobsService
        • CashLetterService
        • CashMachines
        • CheckService
        • CheckVerificationService
        • CollateralService
        • ContactEventMgmtService
        • CorpTransferService
        • CreditReportService
        • DealerService
        • EcaaService
        • EpisysInformationService
        • ExceptionItemService
        • FileManagementService
        • FindByService
        • FinrepService
        • GeneralLedgerService
        • InventoryService
        • MbraddressService
        • MemberService
        • NonAccountNameService
        • ParameterService
          • AccountDefault
          • AccountFieldName
          • AcctLimit
          • AcctMembGrpDesc
          • AcctRelCodeDesc
          • AcctTrackingType
          • AcctTypeName
          • AcsGlobal
          • AcsService
          • ActivityFm
          • AnalysisFloat
          • AnalysisGlobal
          • AnalysisPlan
          • ApPmtTermsTablePagedList
          • ApWorkFlow
          • Atm
          • Audio
          • BatchRc
          • CardDefault
          • CardWiz
          • CashOrderVendor
          • Cdm
          • CheckOrderDefault
          • CollateralType
          • CollatrlTrackingType
          • Comment
          • ConsoleFm
          • CorpTransfer
          • CpLetter
          • CpWorkCard
          • CreditReport
          • Crs
          • CurrencyCtrl
          • DailyPost
          • DealerStatement
          • DebtRatio
          • Disclosure
          • DivIndexGlobal
          • DivIndexLocal
          • DivTable
          • DocExcpNotice
          • DocTypeDefault
          • DocumentNumber
          • EpisysDbExtract
          • EscrowAnalysis
          • EscrowType
          • ExtLoan
          • GlCategory
          • GlCode
          • GlTable
          • GlTrackingType
          • GlxLate
          • IdentIdTypeDesc
          • Imaging
          • InqDefinition
          • InsTable
          • InsType
          • Institution
          • IntIndex
          • IntType
          • InventoryCopiedFlds
          • InventoryDefault
          • InventoryFieldName
          • InventoryType
          • IrsBkupWithhold
          • IrsContriLimit
          • ItcFraud
          • ItcInstallation
          • LateChg
          • LnSegmentDefault
          • LoanAppCopiedFlds
          • LoanAppDefault
          • LoanAppDenial
          • LoanAppFieldName
          • LoanAppFormPkt
          • LoanAppMisc
          • LoanAppPrintApp
          • LoanAppReusedFlds
          • LoanAppVerForm
          • LoanAppViewApp
          • LoanAppWorkFlow
          • LoanDefault
          • LoanFieldName
          • LoanTypeIdRange
          • LookupTypeName
          • Misc
          • MoProduct
          • NameFieldName
          • Ncua5300
          • NonRegCc
          • Notice
          • OnlineBlock
          • OnlineCard
          • OnlineFee
          • OnlineFile
          • OnlineMain
          • OnlineNet
          • OnlineOutlet
          • OnlineSbAddOn
          • OnlineSba
          • OnlineSbi
          • Param360View
          • Parameter
          • PartStatement
          • PartTrackingType
          • ParticipantFieldName
          • PayCalc
          • PeriodicMtg
          • PlanDefault
          • PlanFieldName
          • PmtAppMethod
          • PositivePay
          • PreferenceDefault
          • PrivGroup
          • RegCc
          • ScreenDefinition
          • SecField
          • Security
          • ShareDefault
          • ShareFieldName
          • Statement
          • StmtMailName
          • StmtMessages
          • Stock
          • SycClient
          • SycGeneral
          • SymXClient
          • SymXDeviceMap
          • SymXGeneral
          • SymXInstance
          • SynapsysMrm
          • TcProduct
          • TellerFee
          • TellerTranFee
          • TellerTranValidate
          • Tpt
          • TrackingCode
          • UserFm
          • UserTrackingFm
          • UserTrackingType
          • Warnings
          • WdFee
          • WestUnCommCode
          • WireBfc
          • WireCorpVer
          • WireIdCode
          • WireInCmtCode
          • WireMisc
          • WireOutCmtCode
          • WireTypeCode
          • WorkFlowRepGen
          • YellowHammer
        • ParticipantService
        • PayeeService
        • PowerOnService
        • ProjectionService
        • ReceivedItemService
        • RemittanceService
        • SymXchangeVerificationService
        • TransactionsService
        • UserManagementService
        • UserService
        • WireService
          • Wire
          • WireBeneficiary
            • createWireBeneficiary
            • deleteWireBeneficiary
            • getWireBeneficiary
            • searchWireBeneficiary
            • updateWireBeneficiary
          • WireDrawdownDebit
          • WireFiToFiInfo
          • WireFmHistory
          • WireIntermedFi
          • WireOfacDetails
          • WireReceiverFiInfo
          • WireServiceMessage
          • WireUscAudit
    • Credentials
    • Device Information
Powered by GitBook
On this page

Was this helpful?

  1. SymXchange
  2. API Reference
  3. Persistent
  4. AccountService
  5. Irs

searchIrs

PreviousgetIrsNextupdateIrs

Last updated 10 months ago

Was this helpful?

Perform various search operations on Internal Revenue Service (IRS) records.

Symitar eDocs References: Coming soon.

Operations

  • Operations
  • POSTsearchIrsPagedSelectFields
  • POSTsearchIrsDistributionPagedSelectFields

searchIrsPagedSelectFields

post
Authorizations
Body
AccountNumberstringOptional
Responses
200
Successful operation.
application/json
post
POST /nexum/627/persistent/account/searchIrsPagedSelectFields HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 799

{
  "Credentials": {
    "UserNumberCredentials": {
      "UserNumber": 1995,
      "Password": "2dfKQYR!TeXJwe"
    }
  },
  "AccountNumber": "text",
  "PagingRequestContext": {
    "NumberOfRecordsToReturn": 1,
    "NumberOfRecordsToSkip": 1,
    "Token": "text"
  },
  "SelectableFields": {
    "IncludeAllIrsFields": true,
    "IrsFields": {
      "ActualMaxContribution": true,
      "ContrLastYear": [
        1
      ],
      "ContrThisYear": [
        1
      ],
      "ContributionYear": true,
      "DistrLastYear": [
        1
      ],
      "DistrThisYear": [
        1
      ],
      "FairMarketValueDeath": true,
      "FairMarketValueLastYear": true,
      "IraRmd": true,
      "IrsCode": true,
      "IrsHolderBirthDate": true,
      "IrsHolderSpouseBirthDate": true,
      "IrsPlan": true,
      "LastDistribType": true,
      "Locator": true,
      "MaxContribution": true,
      "MsaHolderCode": true,
      "OpenDate": true,
      "RecordChangeDate": true,
      "RmdTableOption": true,
      "Ssn": true
    }
  },
  "SearchFilter": {
    "Query": "text"
  },
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}
200

Successful operation.

{
  "Irs": [
    {
      "ActualMaxContribution": 1,
      "ContrLastYear": [
        {
          "EntryId": 1,
          "ContrLastYear": 1
        }
      ],
      "ContrThisYear": [
        {
          "EntryId": 1,
          "ContrThisYear": 1
        }
      ],
      "ContributionYear": 1,
      "DistrLastYear": [
        {
          "EntryId": 1,
          "DistrLastYear": 1
        }
      ],
      "DistrThisYear": [
        {
          "EntryId": 1,
          "DistrThisYear": 1
        }
      ],
      "FairMarketValueDeath": 1,
      "FairMarketValueLastYear": 1,
      "IraRmd": 1,
      "IrsCode": 1,
      "IrsDistributionList": {
        "hasReachedMaximumListSize": true,
        "IrsDistribution": [
          {
            "Amount": 1,
            "DestinationAccount": "text",
            "DestinationId": "text",
            "DistributionCode": 1,
            "DistributionDay1": 1,
            "DistributionDay2": 1,
            "DistributionFreq": 1,
            "DistributionMethod": 1,
            "EffectiveDate": "2025-05-19",
            "ExpirationDate": "2025-05-19",
            "FedWholdAmount": 1,
            "FedWholdCode": 1,
            "FedWholdPercent": 1,
            "LastDistributnAmt": 1,
            "LastDistributnDate": "2025-05-19",
            "Locator": 1,
            "NextDistributnDate": "2025-05-19",
            "RecordChangeDate": "2025-05-19",
            "RegE": 1,
            "SourceId": [
              {
                "EntryId": 1,
                "SourceId": "text"
              }
            ],
            "StateWholdAmount": 1,
            "StateWholdCode": 1,
            "StateWholdPercent": 1,
            "Type": 1
          }
        ]
      },
      "IrsHolderBirthDate": "2025-05-19",
      "IrsHolderSpouseBirthDate": "2025-05-19",
      "IrsNameList": {
        "hasReachedMaximumListSize": true,
        "IrsName": [
          {
            "ActiveDuty": 1,
            "ActiveDutySeparationDate": "2025-05-19",
            "ActiveDutyStartDate": "2025-05-19",
            "ActiveDutyVerificationDate": "2025-05-19",
            "AddrCreateDate": "2025-05-19",
            "AddrDisconnectDate": "2025-05-19",
            "AddrExpDate": "2025-05-19",
            "AddrFmLastDate": "2025-05-19",
            "AddrFmLastPurgeDate": "2025-05-19",
            "AddrRecordChangeDate": "2025-05-19",
            "AddressType": 1,
            "AltEmail": "text",
            "BeneficialOwner": 1,
            "BeneficialPercent": 1,
            "BeneficiaryPercent": 1,
            "BirthDate": "2025-05-19",
            "CarrierRoute": "text",
            "Chapter4StatusCode": "text",
            "City": "text",
            "Confidential": 1,
            "Country": "text",
            "CountryCode": "text",
            "CrAddrChgDate": "2025-05-19",
            "CrNameChgDate": "2025-05-19",
            "CrSsnChgDate": "2025-05-19",
            "CreditReportAddrIndicator": "text",
            "CreditReportAddrIndicatorDate": "2025-05-19",
            "CreditReportConsumerInfo": "text",
            "CreditReportConsumerInfoDate": "2025-05-19",
            "CtrExempt": 1,
            "CurrGrossMonthPay": 1,
            "CurrMonthPayChgDate": "2025-05-19",
            "CurrNetMonthPay": 1,
            "DbaExtendedName": "text",
            "DbaFirst": "text",
            "DbaLast": "text",
            "DbaLongName": "text",
            "DbaMiddle": "text",
            "DbaNameFormat": 1,
            "DbaShortName": "text",
            "DbaSuffix": "text",
            "DbaTitle": "text",
            "DeathDate": "2025-05-19",
            "EcoaCode": 1,
            "EffectiveDate": "2025-05-19",
            "Email": "text",
            "EmployerName": "text",
            "ExpirationDate": "2025-05-19",
            "ExtendedName": "text",
            "ExtraAddress": "text",
            "ExtraInfo": "text",
            "First": "text",
            "FmLastPurgeDate": "2025-05-19",
            "ForeignTin": "text",
            "FormW8OnFile": 1,
            "GIin": "text",
            "Headquarters": 1,
            "HomePhone": "text",
            "IdentDocFlag": [
              {
                "EntryId": 1,
                "IdentDocFlag": 1
              }
            ],
            "IdentIdDescription": [
              {
                "EntryId": 1,
                "IdentIdDescription": "text"
              }
            ],
            "IdentIdExpireDate": [
              {
                "EntryId": 1,
                "IdentIdExpireDate": "2025-05-19"
              }
            ],
            "IdentIdIssueDate": [
              {
                "EntryId": 1,
                "IdentIdIssueDate": "2025-05-19"
              }
            ],
            "IdentIdNumber": [
              {
                "EntryId": 1,
                "IdentIdNumber": "text"
              }
            ],
            "IdentIdType": [
              {
                "EntryId": 1,
                "IdentIdType": 1
              }
            ],
            "IdentIdVerifyDate": [
              {
                "EntryId": 1,
                "IdentIdVerifyDate": "2025-05-19"
              }
            ],
            "Irs1042SAmendNum": 1,
            "IrsCorrection": 1,
            "IrsCountryCode": "text",
            "Last": "text",
            "LastAddrChgDate": "2025-05-19",
            "LastAddrVerifDate": "2025-05-19",
            "LastFmDate": "2025-05-19",
            "Lei": "text",
            "License": "text",
            "Lob": "text",
            "Locator": 1,
            "LongName": "text",
            "MailOverride": 1,
            "MarketingAddress": 1,
            "MbrActivityDate": "2025-05-19",
            "MbrAddrFileType": 1,
            "MbrAddrNumLink": "text",
            "MbrAddrNumLinkChgDate": "2025-05-19",
            "MbrAddrNumber": "text",
            "MbrCreateDate": "2025-05-19",
            "MbrDisconnectDate": "2025-05-19",
            "MbrExpDate": "2025-05-19",
            "MbrFileType": 1,
            "MbrFmLastDate": "2025-05-19",
            "MbrFmLastPurgeDate": "2025-05-19",
            "MbrRecordChangeDate": "2025-05-19",
            "MbrStatus": 1,
            "MbrStatusFmDate": "2025-05-19",
            "MemberNumLink": "text",
            "MemberNumLinkChgDate": "2025-05-19",
            "MemberNumber": "text",
            "Middle": "text",
            "MobilePhone": "text",
            "MothersMaidenName": "text",
            "NameFormat": 1,
            "NonAcctNameNum": "text",
            "NraExemptionCode": "text",
            "NraTaxRate": 1,
            "Occupation": "text",
            "PagerNumber": "text",
            "PhoneType": 1,
            "PreferredContact": "text",
            "PreferredContactMethod": 1,
            "RecordChangeDate": "2025-05-19",
            "Restrict": 1,
            "Sex": "text",
            "ShortName": "text",
            "Ssn": "text",
            "SsnCertification": 1,
            "SsnOverride": 1,
            "SsnType": 1,
            "State": "text",
            "Street": "text",
            "SubType": 1,
            "SubstantialOwner": 1,
            "Suffix": "text",
            "Title": "text",
            "Type": 1,
            "UsPersonFlag": 1,
            "UserAmount1": 1,
            "UserAmount2": 1,
            "UserChar1": "text",
            "UserChar2": "text",
            "UserChar3": "text",
            "UserChar4": "text",
            "UserDate1": "2025-05-19",
            "UserDate2": "2025-05-19",
            "W8ExpirationDate": "2025-05-19",
            "WorkPhone": "text",
            "WorkPhoneExtension": "text",
            "ZipCode": "text"
          }
        ]
      },
      "IrsPlan": 1,
      "LastDistribType": 1,
      "Locator": 1,
      "MaxContribution": 1,
      "MsaHolderCode": 1,
      "OpenDate": "2025-05-19",
      "RecordChangeDate": "2025-05-19",
      "RmdTableOption": 1,
      "Ssn": "text"
    }
  ],
  "Token": "text"
}

searchIrsDistributionPagedSelectFields

post
Authorizations
Body
AccountNumberstringOptional
IrsLocatorintegerOptional
Responses
200
Successful operation.
application/json
post
POST /nexum/627/persistent/account/searchIrsDistributionPagedSelectFields HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 906

{
  "Credentials": {
    "UserNumberCredentials": {
      "UserNumber": 1995,
      "Password": "2dfKQYR!TeXJwe"
    }
  },
  "AccountNumber": "text",
  "IrsLocator": 1,
  "PagingRequestContext": {
    "NumberOfRecordsToReturn": 1,
    "NumberOfRecordsToSkip": 1,
    "Token": "text"
  },
  "SelectableFields": {
    "IncludeAllIrsDistributionFields": true,
    "IrsDistributionFields": {
      "Amount": true,
      "DestinationAccount": true,
      "DestinationId": true,
      "DistributionCode": true,
      "DistributionDay1": true,
      "DistributionDay2": true,
      "DistributionFreq": true,
      "DistributionMethod": true,
      "EffectiveDate": true,
      "ExpirationDate": true,
      "FedWholdAmount": true,
      "FedWholdCode": true,
      "FedWholdPercent": true,
      "LastDistributnAmt": true,
      "LastDistributnDate": true,
      "Locator": true,
      "NextDistributnDate": true,
      "RecordChangeDate": true,
      "RegE": true,
      "SourceId": [
        1
      ],
      "StateWholdAmount": true,
      "StateWholdCode": true,
      "StateWholdPercent": true,
      "Type": true
    }
  },
  "SearchFilter": {
    "Query": "text"
  },
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}
200

Successful operation.

{
  "IrsDistribution": [
    {
      "Amount": 1,
      "DestinationAccount": "text",
      "DestinationId": "text",
      "DistributionCode": 1,
      "DistributionDay1": 1,
      "DistributionDay2": 1,
      "DistributionFreq": 1,
      "DistributionMethod": 1,
      "EffectiveDate": "2025-05-19",
      "ExpirationDate": "2025-05-19",
      "FedWholdAmount": 1,
      "FedWholdCode": 1,
      "FedWholdPercent": 1,
      "LastDistributnAmt": 1,
      "LastDistributnDate": "2025-05-19",
      "Locator": 1,
      "NextDistributnDate": "2025-05-19",
      "RecordChangeDate": "2025-05-19",
      "RegE": 1,
      "SourceId": [
        {
          "EntryId": 1,
          "SourceId": "text"
        }
      ],
      "StateWholdAmount": 1,
      "StateWholdCode": 1,
      "StateWholdPercent": 1,
      "Type": 1
    }
  ],
  "Token": "text"
}