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

BalancingService

PreviousAccountsPayableServiceNextBatchJobsService

Last updated 10 months ago

Was this helpful?

Perform balancing operations.

Symitar eDocs References: Coming soon.

Operations

  • Operations
  • POSTresetCashValueBalances
  • POSTresetDepositBalances
  • POSTresetSecondPartyCheckBalances
  • POSTcashValueAdjust
  • POSTsecondPartyCheckAdjust
  • POSTcashValueReport
  • POSTverifyDepositReport
  • POSTcheckDisbursedReport

resetCashValueBalances

post

Resets cash value balances.

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

{
  "Credentials": {
    "UserNumberCredentials": {
      "UserNumber": 1995,
      "Password": "2dfKQYR!TeXJwe"
    }
  },
  "BalanceReportFlag": true,
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}
200

Successful operation.

{
  "StatusMessage": "text",
  "CashValueReport": {
    "BalanceDispenser": [
      {
        "DispenserId": 1,
        "TranGlCode": 1,
        "SourceGlCode": 1,
        "Denomination": 1,
        "BeginAmount": 1,
        "DispenseAmount": 1,
        "ReverseAmount": 1,
        "AdjustAmount": 1,
        "ReplenishAmount": 1,
        "RevTotalAmount": 1,
        "CurrentAmount": 1,
        "WarningAmount": 1
      }
    ]
  }
}

resetDepositBalances

post

Resets deposit balances.

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

{
  "Credentials": {
    "UserNumberCredentials": {
      "UserNumber": 1995,
      "Password": "2dfKQYR!TeXJwe"
    }
  },
  "BalanceReportFlag": true,
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}
200

Successful operation.

{
  "StatusMessage": "text",
  "DepositReport": {
    "Count": 1,
    "Amount": 1,
    "GlCode": 1,
    "GlTranCount": 1
  }
}

resetSecondPartyCheckBalances

post

Resets second-party check balances.

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

{
  "Credentials": {
    "UserNumberCredentials": {
      "UserNumber": 1995,
      "Password": "2dfKQYR!TeXJwe"
    }
  },
  "BalanceReportFlag": true,
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}
200

Successful operation.

{
  "StatusMessage": "text",
  "CheckDisbursedReport": {
    "FirstPartyCount": 1,
    "FirstPartyAmount": 1,
    "BalancePrinter": [
      {
        "PrinterId": 1,
        "TranGlCode": 1,
        "CheckAcctNumber": "text",
        "BeginCount": 1,
        "DispenseCount": 1,
        "DispenseAmount": 1,
        "ReverseCount": 1,
        "ReverseAmount": 1,
        "AdjustCount": 1,
        "ReplenishCount": 1,
        "CurrentCount": 1,
        "RevTotalCount": 1,
        "WarnCount": 1
      }
    ],
    "ThirdPartyCount": 1,
    "ThirdPartyAmount": 1
  }
}

cashValueAdjust

post

Adjusts cash values.

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

{
  "Credentials": {
    "UserNumberCredentials": {
      "UserNumber": 1995,
      "Password": "2dfKQYR!TeXJwe"
    }
  },
  "CashValueAdjustInput": {
    "DispenserAdjust": [
      {
        "GlCode": 1,
        "SrcGlCode": 1,
        "Denomination": 1,
        "AdjustAmount": 1,
        "ReplenishAmount": 1,
        "WarnAmount": 1,
        "ResetDispenser": true,
        "DispenserId": 1
      }
    ]
  },
  "BalanceReportFlag": true,
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}
200

Successful operation.

{
  "StatusMessage": "text",
  "CashValueReport": {
    "BalanceDispenser": [
      {
        "DispenserId": 1,
        "TranGlCode": 1,
        "SourceGlCode": 1,
        "Denomination": 1,
        "BeginAmount": 1,
        "DispenseAmount": 1,
        "ReverseAmount": 1,
        "AdjustAmount": 1,
        "ReplenishAmount": 1,
        "RevTotalAmount": 1,
        "CurrentAmount": 1,
        "WarningAmount": 1
      }
    ]
  }
}

secondPartyCheckAdjust

post

Adjusts second-party checks.

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

{
  "Credentials": {
    "UserNumberCredentials": {
      "UserNumber": 1995,
      "Password": "2dfKQYR!TeXJwe"
    }
  },
  "SecondPartyCheckAdjust": {
    "PrinterAdjust": [
      {
        "PrinterId": 1,
        "GlCode": 1,
        "CheckAcct": "text",
        "AdjustCount": 1,
        "ReplenishCount": 1,
        "WarnCount": 1,
        "ResetPrinter": true
      }
    ]
  },
  "BalanceReportFlag": true,
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}
200

Successful operation.

{
  "StatusMessage": "text",
  "CheckDisbursedReport": {
    "FirstPartyCount": 1,
    "FirstPartyAmount": 1,
    "BalancePrinter": [
      {
        "PrinterId": 1,
        "TranGlCode": 1,
        "CheckAcctNumber": "text",
        "BeginCount": 1,
        "DispenseCount": 1,
        "DispenseAmount": 1,
        "ReverseCount": 1,
        "ReverseAmount": 1,
        "AdjustCount": 1,
        "ReplenishCount": 1,
        "CurrentCount": 1,
        "RevTotalCount": 1,
        "WarnCount": 1
      }
    ],
    "ThirdPartyCount": 1,
    "ThirdPartyAmount": 1
  }
}

cashValueReport

post

Generates a report on cash values.

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

{
  "Credentials": {
    "UserNumberCredentials": {
      "UserNumber": 1995,
      "Password": "2dfKQYR!TeXJwe"
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}
200

Successful operation.

{
  "StatusMessage": "text",
  "CashValueReport": {
    "BalanceDispenser": [
      {
        "DispenserId": 1,
        "TranGlCode": 1,
        "SourceGlCode": 1,
        "Denomination": 1,
        "BeginAmount": 1,
        "DispenseAmount": 1,
        "ReverseAmount": 1,
        "AdjustAmount": 1,
        "ReplenishAmount": 1,
        "RevTotalAmount": 1,
        "CurrentAmount": 1,
        "WarningAmount": 1
      }
    ]
  }
}

verifyDepositReport

post

Verifies deposit reports.

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

{
  "Credentials": {
    "UserNumberCredentials": {
      "UserNumber": 1995,
      "Password": "2dfKQYR!TeXJwe"
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}
200

Successful operation.

{
  "StatusMessage": "text",
  "DepositReport": {
    "Count": 1,
    "Amount": 1,
    "GlCode": 1,
    "GlTranCount": 1
  }
}

checkDisbursedReport

post

Generates a report on disbursed checks.

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

{
  "Credentials": {
    "UserNumberCredentials": {
      "UserNumber": 1995,
      "Password": "2dfKQYR!TeXJwe"
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}
200

Successful operation.

{
  "StatusMessage": "text",
  "CheckDisbursedReport": {
    "FirstPartyCount": 1,
    "FirstPartyAmount": 1,
    "BalancePrinter": [
      {
        "PrinterId": 1,
        "TranGlCode": 1,
        "CheckAcctNumber": "text",
        "BeginCount": 1,
        "DispenseCount": 1,
        "DispenseAmount": 1,
        "ReverseCount": 1,
        "ReverseAmount": 1,
        "AdjustCount": 1,
        "ReplenishCount": 1,
        "CurrentCount": 1,
        "RevTotalCount": 1,
        "WarnCount": 1
      }
    ],
    "ThirdPartyCount": 1,
    "ThirdPartyAmount": 1
  }
}