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. Portfolio

searchPortfolio

PreviousgetPortfolioNextupdatePortfolio

Last updated 10 months ago

Was this helpful?

Perform various search operations on portfolio records.

Symitar eDocs References: Coming soon.

Operations

  • Operations
  • POSTsearchPortfolioPagedSelectFields
  • POSTsearchPortfolioHoldPagedSelectFields

searchPortfolioPagedSelectFields

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

{
  "Credentials": {
    "UserNumberCredentials": {
      "UserNumber": 1995,
      "Password": "2dfKQYR!TeXJwe"
    }
  },
  "AccountNumber": "text",
  "PagingRequestContext": {
    "NumberOfRecordsToReturn": 1,
    "NumberOfRecordsToSkip": 1,
    "Token": "text"
  },
  "SelectableFields": {
    "IncludeAllPortfolioFields": true,
    "PortfolioFields": {
      "AvailableBalance": true,
      "Balance": true,
      "CloseDate": true,
      "Description": true,
      "FmLastDate": true,
      "Id": true,
      "NotePurgeDate": true,
      "RecordChangeDate": true
    }
  },
  "SearchFilter": {
    "Query": "text"
  },
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}
200

Successful operation.

{
  "Portfolio": [
    {
      "AvailableBalance": 1,
      "Balance": 1,
      "CloseDate": "2025-05-22",
      "Description": "text",
      "FmLastDate": "2025-05-22",
      "Id": "text",
      "NotePurgeDate": "2025-05-22",
      "PortfolioHoldList": {
        "hasReachedMaximumListSize": true,
        "PortfolioHold": [
          {
            "AchRecurringStop": 1,
            "Amount": 1,
            "AvailableBalance": 1,
            "EffectiveDate": "2025-05-22",
            "ExpirationDate": "2025-05-22",
            "ExpirationTime": 1,
            "FeeCode": 1,
            "FeeDescription": "text",
            "HoldCreationDate": "2025-05-22",
            "HoldCreationTime": "text",
            "LedgerBalance": 1,
            "Locator": 1,
            "MatchDate": "2025-05-22",
            "MatchTime": 1,
            "MemberBranch": "text",
            "PayeeName": "text",
            "RecordChangeDate": "2025-05-22",
            "Reference1": "text",
            "Reference2": "text",
            "Reference3": "text",
            "Reference4": "text",
            "StopPayCode": 1,
            "TransactionType": 1,
            "Type": 1
          }
        ]
      },
      "PortfolioNoteList": {
        "hasReachedMaximumListSize": true,
        "PortfolioNote": [
          {
            "Code": 1,
            "EnterDate": "2025-05-22",
            "EnterTime": 1,
            "ExpirationDate": "2025-05-22",
            "Id": "text",
            "IdType": 1,
            "Locator": 1,
            "RecordChangeDate": "2025-05-22",
            "Text": [
              {
                "EntryId": 1,
                "Text": "text"
              }
            ],
            "TextLineCount": 1,
            "UserId": 1,
            "VoidFlag": 1,
            "VoidedBy": 1
          }
        ]
      },
      "PortfolioTrackingList": {
        "hasReachedMaximumListSize": true,
        "PortfolioTracking": [
          {
            "CreationDate": "2025-05-22",
            "CreationTime": 1,
            "ExpireDate": "2025-05-22",
            "FmLastDate": "2025-05-22",
            "Id": "text",
            "IdType": 1,
            "Locator": 1,
            "RecordChangeDate": "2025-05-22",
            "TrackingCode": 1,
            "Type": 1,
            "UserAmount1": 1,
            "UserAmount10": 1,
            "UserAmount11": 1,
            "UserAmount12": 1,
            "UserAmount13": 1,
            "UserAmount14": 1,
            "UserAmount15": 1,
            "UserAmount16": 1,
            "UserAmount17": 1,
            "UserAmount18": 1,
            "UserAmount19": 1,
            "UserAmount2": 1,
            "UserAmount20": 1,
            "UserAmount3": 1,
            "UserAmount4": 1,
            "UserAmount5": 1,
            "UserAmount6": 1,
            "UserAmount7": 1,
            "UserAmount8": 1,
            "UserAmount9": 1,
            "UserChar1": "text",
            "UserChar10": "text",
            "UserChar11": "text",
            "UserChar12": "text",
            "UserChar13": "text",
            "UserChar14": "text",
            "UserChar15": "text",
            "UserChar16": "text",
            "UserChar17": "text",
            "UserChar18": "text",
            "UserChar19": "text",
            "UserChar2": "text",
            "UserChar20": "text",
            "UserChar3": "text",
            "UserChar4": "text",
            "UserChar5": "text",
            "UserChar6": "text",
            "UserChar7": "text",
            "UserChar8": "text",
            "UserChar9": "text",
            "UserCode1": 1,
            "UserCode10": 1,
            "UserCode11": 1,
            "UserCode12": 1,
            "UserCode13": 1,
            "UserCode14": 1,
            "UserCode15": 1,
            "UserCode16": 1,
            "UserCode17": 1,
            "UserCode18": 1,
            "UserCode19": 1,
            "UserCode2": 1,
            "UserCode20": 1,
            "UserCode3": 1,
            "UserCode4": 1,
            "UserCode5": 1,
            "UserCode6": 1,
            "UserCode7": 1,
            "UserCode8": 1,
            "UserCode9": 1,
            "UserDate1": "2025-05-22",
            "UserDate10": "2025-05-22",
            "UserDate11": "2025-05-22",
            "UserDate12": "2025-05-22",
            "UserDate13": "2025-05-22",
            "UserDate14": "2025-05-22",
            "UserDate15": "2025-05-22",
            "UserDate16": "2025-05-22",
            "UserDate17": "2025-05-22",
            "UserDate18": "2025-05-22",
            "UserDate19": "2025-05-22",
            "UserDate2": "2025-05-22",
            "UserDate20": "2025-05-22",
            "UserDate3": "2025-05-22",
            "UserDate4": "2025-05-22",
            "UserDate5": "2025-05-22",
            "UserDate6": "2025-05-22",
            "UserDate7": "2025-05-22",
            "UserDate8": "2025-05-22",
            "UserDate9": "2025-05-22",
            "UserId": 1,
            "UserNumber1": 1,
            "UserNumber10": 1,
            "UserNumber11": 1,
            "UserNumber12": 1,
            "UserNumber13": 1,
            "UserNumber14": 1,
            "UserNumber15": 1,
            "UserNumber16": 1,
            "UserNumber17": 1,
            "UserNumber18": 1,
            "UserNumber19": 1,
            "UserNumber2": 1,
            "UserNumber20": 1,
            "UserNumber3": 1,
            "UserNumber4": 1,
            "UserNumber5": 1,
            "UserNumber6": 1,
            "UserNumber7": 1,
            "UserNumber8": 1,
            "UserNumber9": 1,
            "UserRate1": 1,
            "UserRate10": 1,
            "UserRate11": 1,
            "UserRate12": 1,
            "UserRate13": 1,
            "UserRate14": 1,
            "UserRate15": 1,
            "UserRate16": 1,
            "UserRate17": 1,
            "UserRate18": 1,
            "UserRate19": 1,
            "UserRate2": 1,
            "UserRate20": 1,
            "UserRate3": 1,
            "UserRate4": 1,
            "UserRate5": 1,
            "UserRate6": 1,
            "UserRate7": 1,
            "UserRate8": 1,
            "UserRate9": 1
          }
        ]
      },
      "RecordChangeDate": "2025-05-22"
    }
  ],
  "Token": "text"
}

searchPortfolioHoldPagedSelectFields

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

{
  "Credentials": {
    "UserNumberCredentials": {
      "UserNumber": 1995,
      "Password": "2dfKQYR!TeXJwe"
    }
  },
  "AccountNumber": "text",
  "PortfolioId": "text",
  "PagingRequestContext": {
    "NumberOfRecordsToReturn": 1,
    "NumberOfRecordsToSkip": 1,
    "Token": "text"
  },
  "SelectableFields": {
    "IncludeAllPortfolioHoldFields": true,
    "PortfolioHoldFields": {
      "AchRecurringStop": true,
      "Amount": true,
      "AvailableBalance": true,
      "EffectiveDate": true,
      "ExpirationDate": true,
      "ExpirationTime": true,
      "FeeCode": true,
      "FeeDescription": true,
      "HoldCreationDate": true,
      "HoldCreationTime": true,
      "LedgerBalance": true,
      "Locator": true,
      "MatchDate": true,
      "MatchTime": true,
      "MemberBranch": true,
      "PayeeName": true,
      "RecordChangeDate": true,
      "Reference1": true,
      "Reference2": true,
      "Reference3": true,
      "Reference4": true,
      "StopPayCode": true,
      "TransactionType": true,
      "Type": true
    }
  },
  "SearchFilter": {
    "Query": "text"
  },
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}
200

Successful operation.

{
  "PortfolioHold": [
    {
      "AchRecurringStop": 1,
      "Amount": 1,
      "AvailableBalance": 1,
      "EffectiveDate": "2025-05-22",
      "ExpirationDate": "2025-05-22",
      "ExpirationTime": 1,
      "FeeCode": 1,
      "FeeDescription": "text",
      "HoldCreationDate": "2025-05-22",
      "HoldCreationTime": "text",
      "LedgerBalance": 1,
      "Locator": 1,
      "MatchDate": "2025-05-22",
      "MatchTime": 1,
      "MemberBranch": "text",
      "PayeeName": "text",
      "RecordChangeDate": "2025-05-22",
      "Reference1": "text",
      "Reference2": "text",
      "Reference3": "text",
      "Reference4": "text",
      "StopPayCode": 1,
      "TransactionType": 1,
      "Type": 1
    }
  ],
  "Token": "text"
}