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. v2022.01
  4. ParameterService

StmtMessages

PreviousStmtMailNameNextStock

Last updated 10 months ago

Was this helpful?

Perform various operations for Symitar parameters.

Symitar eDocs References: Coming soon.

Operations

  • Operations
  • POSTgetStmtMessages
  • POSTgetStmtMessagesSelectFields
  • POSTgetStmtMessagesPagedList
  • POSTgetStmtMessagesListSelectFields
  • POSTsearchStmtMessagesSelectFields
  • POSTgetStmtMessagesPagedListSelectFields
  • POSTsearchStmtMessagesPagedSelectFields
  • POSTupdateStmtMessagesByID

getStmtMessages

post

Retrieve getStmtMessages data.

Authorizations
Body
StmtMessagesStatementMessageCodeintegerRequired
Responses
200
Successful operation.
application/json
post
POST /nexum/627/2022.01/parameter/getStmtMessages HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 161

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "StmtMessagesStatementMessageCode": 1,
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}
200

Successful operation.

{
  "StmtMessages": {
    "DefinedCode": 1,
    "Description": "text",
    "Line1": "text",
    "Line10": "text",
    "Line11": "text",
    "Line12": "text",
    "Line2": "text",
    "Line3": "text",
    "Line4": "text",
    "Line5": "text",
    "Line6": "text",
    "Line7": "text",
    "Line8": "text",
    "Line9": "text",
    "StatementMessageCode": 1
  }
}

getStmtMessagesSelectFields

post

Retrieve getStmtMessagesSelectFields data.

Authorizations
Body
StmtMessagesStatementMessageCodeintegerOptional
Responses
200
Successful operation.
application/json
post
POST /nexum/627/2022.01/parameter/getStmtMessagesSelectFields HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 466

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "StmtMessagesStatementMessageCode": 1,
  "SelectableFields": {
    "IncludeAllStmtMessagesFields": true,
    "StmtMessagesFields": {
      "DefinedCode": true,
      "Description": true,
      "Line1": true,
      "Line10": true,
      "Line11": true,
      "Line12": true,
      "Line2": true,
      "Line3": true,
      "Line4": true,
      "Line5": true,
      "Line6": true,
      "Line7": true,
      "Line8": true,
      "Line9": true,
      "StatementMessageCode": true
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}
200

Successful operation.

{
  "StmtMessages": {
    "DefinedCode": 1,
    "Description": "text",
    "Line1": "text",
    "Line10": "text",
    "Line11": "text",
    "Line12": "text",
    "Line2": "text",
    "Line3": "text",
    "Line4": "text",
    "Line5": "text",
    "Line6": "text",
    "Line7": "text",
    "Line8": "text",
    "Line9": "text",
    "StatementMessageCode": 1
  }
}

getStmtMessagesPagedList

post

Retrieve getStmtMessagesPagedList data.

Authorizations
Body
Responses
200
Successful operation.
application/json
post
POST /nexum/627/2022.01/parameter/getStmtMessagesPagedList HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 218

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "PagingRequestContext": {
    "NumberOfRecordsToReturn": 1,
    "NumberOfRecordsToSkip": 1,
    "Token": "text"
  },
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}
200

Successful operation.

{
  "StmtMessages": [
    {
      "DefinedCode": 1,
      "Description": "text",
      "Line1": "text",
      "Line10": "text",
      "Line11": "text",
      "Line12": "text",
      "Line2": "text",
      "Line3": "text",
      "Line4": "text",
      "Line5": "text",
      "Line6": "text",
      "Line7": "text",
      "Line8": "text",
      "Line9": "text",
      "StatementMessageCode": 1
    }
  ],
  "Token": "text"
}

getStmtMessagesListSelectFields

post

Retrieve getStmtMessagesListSelectFields data.

Authorizations
Body
Responses
200
Successful operation.
application/json
post
POST /nexum/627/2022.01/parameter/getStmtMessagesListSelectFields HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 429

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "SelectableFields": {
    "IncludeAllStmtMessagesFields": true,
    "StmtMessagesFields": {
      "DefinedCode": true,
      "Description": true,
      "Line1": true,
      "Line10": true,
      "Line11": true,
      "Line12": true,
      "Line2": true,
      "Line3": true,
      "Line4": true,
      "Line5": true,
      "Line6": true,
      "Line7": true,
      "Line8": true,
      "Line9": true,
      "StatementMessageCode": true
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}
200

Successful operation.

{
  "StmtMessagesList": {
    "hasReachedMaximumListSize": true,
    "StmtMessages": [
      {
        "DefinedCode": 1,
        "Description": "text",
        "Line1": "text",
        "Line10": "text",
        "Line11": "text",
        "Line12": "text",
        "Line2": "text",
        "Line3": "text",
        "Line4": "text",
        "Line5": "text",
        "Line6": "text",
        "Line7": "text",
        "Line8": "text",
        "Line9": "text",
        "StatementMessageCode": 1
      }
    ]
  }
}

searchStmtMessagesSelectFields

post

Retrieve a list of select fields for statement messages

Authorizations
Body
Responses
200
Successful operation.
application/json
post
POST /nexum/627/2022.01/parameter/searchStmtMessagesSelectFields HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 461

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "SelectableFields": {
    "IncludeAllStmtMessagesFields": true,
    "StmtMessagesFields": {
      "DefinedCode": true,
      "Description": true,
      "Line1": true,
      "Line10": true,
      "Line11": true,
      "Line12": true,
      "Line2": true,
      "Line3": true,
      "Line4": true,
      "Line5": true,
      "Line6": true,
      "Line7": true,
      "Line8": true,
      "Line9": true,
      "StatementMessageCode": true
    }
  },
  "SearchFilter": {
    "Query": "text"
  },
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}
200

Successful operation.

{
  "StmtMessagesList": {
    "hasReachedMaximumListSize": true,
    "StmtMessages": [
      {
        "DefinedCode": 1,
        "Description": "text",
        "Line1": "text",
        "Line10": "text",
        "Line11": "text",
        "Line12": "text",
        "Line2": "text",
        "Line3": "text",
        "Line4": "text",
        "Line5": "text",
        "Line6": "text",
        "Line7": "text",
        "Line8": "text",
        "Line9": "text",
        "StatementMessageCode": 1
      }
    ]
  }
}

getStmtMessagesPagedListSelectFields

post

Retrieve getStmtMessagesPagedListSelectFields data.

Authorizations
Body
Responses
200
Successful operation.
application/json
post
POST /nexum/627/2022.01/parameter/getStmtMessagesPagedListSelectFields HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 523

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "PagingRequestContext": {
    "NumberOfRecordsToReturn": 1,
    "NumberOfRecordsToSkip": 1,
    "Token": "text"
  },
  "SelectableFields": {
    "IncludeAllStmtMessagesFields": true,
    "StmtMessagesFields": {
      "DefinedCode": true,
      "Description": true,
      "Line1": true,
      "Line10": true,
      "Line11": true,
      "Line12": true,
      "Line2": true,
      "Line3": true,
      "Line4": true,
      "Line5": true,
      "Line6": true,
      "Line7": true,
      "Line8": true,
      "Line9": true,
      "StatementMessageCode": true
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}
200

Successful operation.

{
  "StmtMessages": [
    {
      "DefinedCode": 1,
      "Description": "text",
      "Line1": "text",
      "Line10": "text",
      "Line11": "text",
      "Line12": "text",
      "Line2": "text",
      "Line3": "text",
      "Line4": "text",
      "Line5": "text",
      "Line6": "text",
      "Line7": "text",
      "Line8": "text",
      "Line9": "text",
      "StatementMessageCode": 1
    }
  ],
  "Token": "text"
}

searchStmtMessagesPagedSelectFields

post

Retrieve a paged list of select fields for statement messages

Authorizations
Body
QuerystringOptional
Responses
200
Successful operation.
application/json
post
POST /nexum/627/2022.01/parameter/searchStmtMessagesPagedSelectFields HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 538

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "PagingRequestContext": {
    "NumberOfRecordsToReturn": 1,
    "NumberOfRecordsToSkip": 1,
    "Token": "text"
  },
  "SelectableFields": {
    "IncludeAllStmtMessagesFields": true,
    "StmtMessagesFields": {
      "DefinedCode": true,
      "Description": true,
      "Line1": true,
      "Line10": true,
      "Line11": true,
      "Line12": true,
      "Line2": true,
      "Line3": true,
      "Line4": true,
      "Line5": true,
      "Line6": true,
      "Line7": true,
      "Line8": true,
      "Line9": true,
      "StatementMessageCode": true
    }
  },
  "Query": "text",
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}
200

Successful operation.

{
  "StmtMessages": [
    {
      "DefinedCode": 1,
      "Description": "text",
      "Line1": "text",
      "Line10": "text",
      "Line11": "text",
      "Line12": "text",
      "Line2": "text",
      "Line3": "text",
      "Line4": "text",
      "Line5": "text",
      "Line6": "text",
      "Line7": "text",
      "Line8": "text",
      "Line9": "text",
      "StatementMessageCode": 1
    }
  ],
  "Token": "text"
}

updateStmtMessagesByID

post

Update statement messages by ID

Authorizations
Body
StmtMessagesStatementMessageCodeintegerOptional
Responses
200
Successful operation.
application/json
post
POST /nexum/627/2022.01/parameter/updateStmtMessagesByID HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 413

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "StmtMessagesStatementMessageCode": 1,
  "StmtMessagesUpdatableFields": {
    "DefinedCode": 1,
    "Description": "text",
    "Line1": "text",
    "Line10": "text",
    "Line11": "text",
    "Line12": "text",
    "Line2": "text",
    "Line3": "text",
    "Line4": "text",
    "Line5": "text",
    "Line6": "text",
    "Line7": "text",
    "Line8": "text",
    "Line9": "text"
  },
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}
200

Successful operation.

{
  "UpdateStatus": {
    "isAllFieldsUpdateSuccess": true,
    "FailedUpdateStatus": [
      {
        "Record": "text",
        "ErrorCode": "text",
        "ErrorMessage": "text",
        "PrimaryKeyField": [
          {
            "Name": "text",
            "Value": "text"
          }
        ]
      }
    ]
  }
}