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

GlCode

PreviousGlCategoryNextGlTable

Last updated 10 months ago

Was this helpful?

Perform various operations for Symitar parameters.

Symitar eDocs References: Coming soon.

Operations

  • Operations
  • POSTgetGlCode
  • POSTgetGlCodeSelectFields
  • POSTgetGlCodePagedList
  • POSTgetGlCodeListSelectFields
  • POSTsearchGlCodeSelectFields
  • POSTgetGlCodePagedListSelectFields
  • POSTsearchGlCodePagedSelectFields
  • POSTupdateGlCodeByID

getGlCode

post

Retrieve GL code data.

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

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

Successful operation.

{
  "GlCode": {
    "BRXlate": 1,
    "Description": "text",
    "PrimaryGlCode": 1,
    "XlateCount": 1,
    "XlateDetail": 1,
    "XlateGroup": 1,
    "XlateType": 1
  }
}

getGlCodeSelectFields

post

Retrieve select fields for GL code data.

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "GlCodePrimaryGlCode": 1,
  "SelectableFields": {
    "IncludeAllGlCodeFields": true,
    "GlCodeFields": {
      "BRXlate": true,
      "Description": true,
      "PrimaryGlCode": true,
      "XlateCount": true,
      "XlateDetail": true,
      "XlateGroup": true,
      "XlateType": true
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}
200

Successful operation.

{
  "GlCode": {
    "BRXlate": 1,
    "Description": "text",
    "PrimaryGlCode": 1,
    "XlateCount": 1,
    "XlateDetail": 1,
    "XlateGroup": 1,
    "XlateType": 1
  }
}

getGlCodePagedList

post

Retrieve paged GL code data.

Authorizations
Body
Responses
200
Successful operation.
application/json
post
POST /nexum/627/2022.01/parameter/getGlCodePagedList 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.

{
  "GlCode": [
    {
      "BRXlate": 1,
      "Description": "text",
      "PrimaryGlCode": 1,
      "XlateCount": 1,
      "XlateDetail": 1,
      "XlateGroup": 1,
      "XlateType": 1
    }
  ],
  "Token": "text"
}

getGlCodeListSelectFields

post

Retrieve select fields for a list of GL code data.

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "SelectableFields": {
    "IncludeAllGlCodeFields": true,
    "GlCodeFields": {
      "BRXlate": true,
      "Description": true,
      "PrimaryGlCode": true,
      "XlateCount": true,
      "XlateDetail": true,
      "XlateGroup": true,
      "XlateType": true
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}
200

Successful operation.

{
  "GlCodeList": {
    "hasReachedMaximumListSize": true,
    "GlCode": [
      {
        "BRXlate": 1,
        "Description": "text",
        "PrimaryGlCode": 1,
        "XlateCount": 1,
        "XlateDetail": 1,
        "XlateGroup": 1,
        "XlateType": 1
      }
    ]
  }
}

searchGlCodeSelectFields

post

Field for selecting various options related to searchglcodeselectfields

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "SelectableFields": {
    "IncludeAllGlCodeFields": true,
    "GlCodeFields": {
      "BRXlate": true,
      "Description": true,
      "PrimaryGlCode": true,
      "XlateCount": true,
      "XlateDetail": true,
      "XlateGroup": true,
      "XlateType": true
    }
  },
  "SearchFilter": {
    "Query": "text"
  },
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}
200

Successful operation.

{
  "GlCodeList": {
    "hasReachedMaximumListSize": true,
    "GlCode": [
      {
        "BRXlate": 1,
        "Description": "text",
        "PrimaryGlCode": 1,
        "XlateCount": 1,
        "XlateDetail": 1,
        "XlateGroup": 1,
        "XlateType": 1
      }
    ]
  }
}

getGlCodePagedListSelectFields

post

Retrieve select fields for paged GL code data.

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "PagingRequestContext": {
    "NumberOfRecordsToReturn": 1,
    "NumberOfRecordsToSkip": 1,
    "Token": "text"
  },
  "SelectableFields": {
    "IncludeAllGlCodeFields": true,
    "GlCodeFields": {
      "BRXlate": true,
      "Description": true,
      "PrimaryGlCode": true,
      "XlateCount": true,
      "XlateDetail": true,
      "XlateGroup": true,
      "XlateType": true
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}
200

Successful operation.

{
  "GlCode": [
    {
      "BRXlate": 1,
      "Description": "text",
      "PrimaryGlCode": 1,
      "XlateCount": 1,
      "XlateDetail": 1,
      "XlateGroup": 1,
      "XlateType": 1
    }
  ],
  "Token": "text"
}

searchGlCodePagedSelectFields

post

Field for selecting various options related to searchglcodepagedselectfields

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "PagingRequestContext": {
    "NumberOfRecordsToReturn": 1,
    "NumberOfRecordsToSkip": 1,
    "Token": "text"
  },
  "SelectableFields": {
    "IncludeAllGlCodeFields": true,
    "GlCodeFields": {
      "BRXlate": true,
      "Description": true,
      "PrimaryGlCode": true,
      "XlateCount": true,
      "XlateDetail": true,
      "XlateGroup": true,
      "XlateType": true
    }
  },
  "Query": "text",
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}
200

Successful operation.

{
  "GlCode": [
    {
      "BRXlate": 1,
      "Description": "text",
      "PrimaryGlCode": 1,
      "XlateCount": 1,
      "XlateDetail": 1,
      "XlateGroup": 1,
      "XlateType": 1
    }
  ],
  "Token": "text"
}

updateGlCodeByID

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "GlCodePrimaryGlCode": 1,
  "GlCodeUpdatableFields": {
    "BRXlate": 1,
    "Description": "text",
    "XlateDetail": 1,
    "XlateGroup": 1,
    "XlateType": 1
  },
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}
200

Successful operation.

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