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

ProjectionService

PreviousPowerOnServiceNextReceivedItemService

Last updated 10 months ago

Was this helpful?

Perform projection calculations.

Symitar eDocs References: Coming soon.

Operations

  • Operations
  • POSTcalculatePaymentAmount
  • POSTcalculateLoanAmount
  • POSTcalculateLoanTerm

calculatePaymentAmount

post

Computes the payment amount for a loan considering relevant factors.

Authorizations
Body
InterestRatenumber · floatOptional
InterestTypeintegerOptional
PaymentFrequencyintegerOptional
MAprPrepaidFinanceChgnumber · floatOptional
MilitaryAprLoanbooleanOptional
DqCalculationMethodintegerOptional
DueDateAdvanceCodeintegerOptional
LoanDatestring · dateOptional
PaymentTypeintegerOptional
PaymentCalculationTypeintegerOptional
AmortizeScheduleintegerOptional
AmortizeScheduleTypeintegerOptional
PaymentSkipsintegerOptional
PaymentSkipStartDayintegerOptional
DueDay1integerOptional
DueDay2integerOptional
FirstDueDatestring · dateOptional
BalloonDatestring · dateOptional
BalloonAmountnumber · floatOptional
FirstInsuredBirthDatestring · dateOptional
SecondInsuredBirthDatestring · dateOptional
InsuranceTypeintegerOptional
EscrowAmountnumber · floatOptional
PrepaidFinanceChgnumber · floatOptional
LoanAmountnumber · floatOptional
MaturityDatestring · dateOptional
Responses
200
Successful operation.
application/json
post
POST /nexum/627/persistent/projection/calculatePaymentAmount HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 716

{
  "Credentials": {
    "UserNumberCredentials": {
      "UserNumber": 1995,
      "Password": "2dfKQYR!TeXJwe"
    }
  },
  "InterestRate": 1,
  "InterestType": 1,
  "PaymentFrequency": 1,
  "MAprPrepaidFinanceChg": 1,
  "MilitaryAprLoan": true,
  "DqCalculationMethod": 1,
  "DueDateAdvanceCode": 1,
  "LoanDate": "2025-05-18",
  "PaymentType": 1,
  "PaymentCalculationType": 1,
  "AmortizeSchedule": 1,
  "AmortizeScheduleType": 1,
  "PaymentSkips": 1,
  "PaymentSkipStartDay": 1,
  "DueDay1": 1,
  "DueDay2": 1,
  "FirstDueDate": "2025-05-18",
  "BalloonDate": "2025-05-18",
  "BalloonAmount": 1,
  "FirstInsuredBirthDate": "2025-05-18",
  "SecondInsuredBirthDate": "2025-05-18",
  "InsuranceType": 1,
  "EscrowAmount": 1,
  "PrepaidFinanceChg": 1,
  "LoanAmount": 1,
  "MaturityDate": "2025-05-18",
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}
200

Successful operation.

{
  "StatusMessage": "text",
  "Payment": 1,
  "LoanAmount": 1,
  "PaymentCount": 1,
  "FinalPayment": 1,
  "FinalDueDate": "2025-05-18",
  "FirstPaymentDate": "2025-05-18",
  "TotalInterest": 1,
  "TotalPayments": 1,
  "TotalEscrow": 1,
  "TotalMaprFees": 1,
  "Life": 1,
  "Disability": 1,
  "LifeError": "text",
  "DisabilityError": "text",
  "Apr": 1,
  "Mapr": 1
}

calculateLoanAmount

post

Determines the loan amount based on specified parameters.

Authorizations
Body
InterestRatenumber · floatOptional
InterestTypeintegerOptional
PaymentFrequencyintegerOptional
MAprPrepaidFinanceChgnumber · floatOptional
MilitaryAprLoanbooleanOptional
DqCalculationMethodintegerOptional
DueDateAdvanceCodeintegerOptional
LoanDatestring · dateOptional
PaymentTypeintegerOptional
PaymentCalculationTypeintegerOptional
AmortizeScheduleintegerOptional
AmortizeScheduleTypeintegerOptional
PaymentSkipsintegerOptional
PaymentSkipStartDayintegerOptional
DueDay1integerOptional
DueDay2integerOptional
FirstDueDatestring · dateOptional
BalloonDatestring · dateOptional
BalloonAmountnumber · floatOptional
FirstInsuredBirthDatestring · dateOptional
SecondInsuredBirthDatestring · dateOptional
InsuranceTypeintegerOptional
EscrowAmountnumber · floatOptional
PrepaidFinanceChgnumber · floatOptional
MaturityDatestring · dateOptional
Paymentnumber · floatOptional
Responses
200
Successful operation.
application/json
post
POST /nexum/627/persistent/projection/calculateLoanAmount HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 713

{
  "Credentials": {
    "UserNumberCredentials": {
      "UserNumber": 1995,
      "Password": "2dfKQYR!TeXJwe"
    }
  },
  "InterestRate": 1,
  "InterestType": 1,
  "PaymentFrequency": 1,
  "MAprPrepaidFinanceChg": 1,
  "MilitaryAprLoan": true,
  "DqCalculationMethod": 1,
  "DueDateAdvanceCode": 1,
  "LoanDate": "2025-05-18",
  "PaymentType": 1,
  "PaymentCalculationType": 1,
  "AmortizeSchedule": 1,
  "AmortizeScheduleType": 1,
  "PaymentSkips": 1,
  "PaymentSkipStartDay": 1,
  "DueDay1": 1,
  "DueDay2": 1,
  "FirstDueDate": "2025-05-18",
  "BalloonDate": "2025-05-18",
  "BalloonAmount": 1,
  "FirstInsuredBirthDate": "2025-05-18",
  "SecondInsuredBirthDate": "2025-05-18",
  "InsuranceType": 1,
  "EscrowAmount": 1,
  "PrepaidFinanceChg": 1,
  "MaturityDate": "2025-05-18",
  "Payment": 1,
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}
200

Successful operation.

{
  "StatusMessage": "text",
  "Payment": 1,
  "LoanAmount": 1,
  "PaymentCount": 1,
  "FinalPayment": 1,
  "FinalDueDate": "2025-05-18",
  "FirstPaymentDate": "2025-05-18",
  "TotalInterest": 1,
  "TotalPayments": 1,
  "TotalEscrow": 1,
  "TotalMaprFees": 1,
  "Life": 1,
  "Disability": 1,
  "LifeError": "text",
  "DisabilityError": "text",
  "Apr": 1,
  "Mapr": 1
}

calculateLoanTerm

post

Calculates the loan term (duration) based on given criteria.

Authorizations
Body
InterestRatenumber · floatOptional
InterestTypeintegerOptional
PaymentFrequencyintegerOptional
MAprPrepaidFinanceChgnumber · floatOptional
MilitaryAprLoanbooleanOptional
DqCalculationMethodintegerOptional
DueDateAdvanceCodeintegerOptional
LoanDatestring · dateOptional
PaymentTypeintegerOptional
PaymentCalculationTypeintegerOptional
AmortizeScheduleintegerOptional
AmortizeScheduleTypeintegerOptional
PaymentSkipsintegerOptional
PaymentSkipStartDayintegerOptional
DueDay1integerOptional
DueDay2integerOptional
FirstDueDatestring · dateOptional
BalloonDatestring · dateOptional
BalloonAmountnumber · floatOptional
FirstInsuredBirthDatestring · dateOptional
SecondInsuredBirthDatestring · dateOptional
InsuranceTypeintegerOptional
EscrowAmountnumber · floatOptional
PrepaidFinanceChgnumber · floatOptional
LoanAmountnumber · floatOptional
Paymentnumber · floatOptional
Responses
200
Successful operation.
application/json
post
POST /nexum/627/persistent/projection/calculateLoanTerm HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 700

{
  "Credentials": {
    "UserNumberCredentials": {
      "UserNumber": 1995,
      "Password": "2dfKQYR!TeXJwe"
    }
  },
  "InterestRate": 1,
  "InterestType": 1,
  "PaymentFrequency": 1,
  "MAprPrepaidFinanceChg": 1,
  "MilitaryAprLoan": true,
  "DqCalculationMethod": 1,
  "DueDateAdvanceCode": 1,
  "LoanDate": "2025-05-18",
  "PaymentType": 1,
  "PaymentCalculationType": 1,
  "AmortizeSchedule": 1,
  "AmortizeScheduleType": 1,
  "PaymentSkips": 1,
  "PaymentSkipStartDay": 1,
  "DueDay1": 1,
  "DueDay2": 1,
  "FirstDueDate": "2025-05-18",
  "BalloonDate": "2025-05-18",
  "BalloonAmount": 1,
  "FirstInsuredBirthDate": "2025-05-18",
  "SecondInsuredBirthDate": "2025-05-18",
  "InsuranceType": 1,
  "EscrowAmount": 1,
  "PrepaidFinanceChg": 1,
  "LoanAmount": 1,
  "Payment": 1,
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}
200

Successful operation.

{
  "StatusMessage": "text",
  "Payment": 1,
  "LoanAmount": 1,
  "PaymentCount": 1,
  "FinalPayment": 1,
  "FinalDueDate": "2025-05-18",
  "FirstPaymentDate": "2025-05-18",
  "TotalInterest": 1,
  "TotalPayments": 1,
  "TotalEscrow": 1,
  "TotalMaprFees": 1,
  "Life": 1,
  "Disability": 1,
  "LifeError": "text",
  "DisabilityError": "text",
  "Apr": 1,
  "Mapr": 1
}