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

Site

PreviousupdateShareNextTracking

Last updated 10 months ago

Was this helpful?

Perform various operations on site records.

Symitar eDocs References: Coming soon.

Operations

  • Operations
  • POSTgetSite
  • POSTgetSiteSelectFields
  • POSTgetSiteSelectFieldsFilterChildren
  • POSTgetSitePagedList
  • POSTgetSiteListSelectFields
  • POSTsearchSiteSelectFields
  • POSTgetSitePagedListSelectFields
  • POSTsearchSitePagedSelectFields
  • POSTgetSiteCashOrderType
  • POSTgetSiteCashOrderTypeSelectFields
  • POSTgetSiteCashOrderTypePagedList
  • POSTgetSiteCashOrderTypeListSelectFields
  • POSTsearchSiteCashOrderTypeSelectFields
  • POSTgetSiteCashOrderTypePagedListSelectFields
  • POSTsearchSiteCashOrderTypePagedSelectFields
  • POSTupdateSiteByID
  • POSTupdateSiteCashOrderTypeByID
  • POSTcreateSite
  • POSTcreateSiteCashOrderType

getSite

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

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

Successful operation.

{
  "Site": {
    "City": "text",
    "CloseDate": "2025-05-21",
    "ContactPhone": "text",
    "ExtraAddress": "text",
    "FaxPhone": "text",
    "Locator": 1,
    "RecordChangeDate": "2025-05-21",
    "SiteContactName": "text",
    "SiteId": "text",
    "SiteName": "text",
    "SiteNumber": 1,
    "SiteSettleShareId": "text",
    "State": "text",
    "Street": "text",
    "ZipCode": "text",
    "SiteCashOrderTypeList": {
      "hasReachedMaximumListSize": true,
      "SiteCashOrderType": [
        {
          "ActiveFlag": 1,
          "ApplyHandlingFee": 1,
          "CashOrderTypeCoinBag": [
            {
              "EntryId": 1,
              "CashOrderTypeCoinBag": 1
            }
          ],
          "CashOrderTypeCoinRoll": [
            {
              "EntryId": 1,
              "CashOrderTypeCoinRoll": 1
            }
          ],
          "CashOrderTypeComment": [
            {
              "EntryId": 1,
              "CashOrderTypeComment": "text"
            }
          ],
          "CashOrderTypeCurrFit": [
            {
              "EntryId": 1,
              "CashOrderTypeCurrFit": 1
            }
          ],
          "CashOrderTypeCurrNew": [
            {
              "EntryId": 1,
              "CashOrderTypeCurrNew": 1
            }
          ],
          "CashOrderTypeDelCharge": 1,
          "CashOrderTypeMaxOrder": 1,
          "CashOrderTypeMinOrder": 1,
          "CashOrderTypeName": "text",
          "CashOrderTypeSpecDelCharge": 1,
          "CloseDate": "2025-05-21",
          "DelFrequency": 1,
          "DeliveryDays": [
            {
              "EntryId": 1,
              "DeliveryDays": 1
            }
          ],
          "LocationCode": "text",
          "Locator": 1,
          "OrderLimiting": 1,
          "RecordChangeDate": "2025-05-21",
          "SpecHandlingFee": 1,
          "VendorNumber": 1
        }
      ]
    }
  }
}

getSiteSelectFields

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

{
  "Credentials": {
    "UserNumberCredentials": {
      "UserNumber": 1995,
      "Password": "2dfKQYR!TeXJwe"
    }
  },
  "AccountNumber": "text",
  "SiteLocator": 1,
  "SelectableFields": {
    "IncludeAllSiteFields": true,
    "SiteFields": {
      "City": true,
      "CloseDate": true,
      "ContactPhone": true,
      "ExtraAddress": true,
      "FaxPhone": true,
      "Locator": true,
      "RecordChangeDate": true,
      "SiteContactName": true,
      "SiteId": true,
      "SiteName": true,
      "SiteNumber": true,
      "SiteSettleShareId": true,
      "State": true,
      "Street": true,
      "ZipCode": true
    },
    "SiteCashOrderTypeSelectableFields": {
      "IncludeAllSiteCashOrderTypeFields": true,
      "SiteCashOrderTypeFields": {
        "ActiveFlag": true,
        "ApplyHandlingFee": true,
        "CashOrderTypeCoinBag": [
          1
        ],
        "CashOrderTypeCoinRoll": [
          1
        ],
        "CashOrderTypeComment": [
          1
        ],
        "CashOrderTypeCurrFit": [
          1
        ],
        "CashOrderTypeCurrNew": [
          1
        ],
        "CashOrderTypeDelCharge": true,
        "CashOrderTypeMaxOrder": true,
        "CashOrderTypeMinOrder": true,
        "CashOrderTypeName": true,
        "CashOrderTypeSpecDelCharge": true,
        "CloseDate": true,
        "DelFrequency": true,
        "DeliveryDays": [
          1
        ],
        "LocationCode": true,
        "Locator": true,
        "OrderLimiting": true,
        "RecordChangeDate": true,
        "SpecHandlingFee": true,
        "VendorNumber": true
      }
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}
200

Successful operation.

{
  "Site": {
    "City": "text",
    "CloseDate": "2025-05-21",
    "ContactPhone": "text",
    "ExtraAddress": "text",
    "FaxPhone": "text",
    "Locator": 1,
    "RecordChangeDate": "2025-05-21",
    "SiteContactName": "text",
    "SiteId": "text",
    "SiteName": "text",
    "SiteNumber": 1,
    "SiteSettleShareId": "text",
    "State": "text",
    "Street": "text",
    "ZipCode": "text",
    "SiteCashOrderTypeList": {
      "hasReachedMaximumListSize": true,
      "SiteCashOrderType": [
        {
          "ActiveFlag": 1,
          "ApplyHandlingFee": 1,
          "CashOrderTypeCoinBag": [
            {
              "EntryId": 1,
              "CashOrderTypeCoinBag": 1
            }
          ],
          "CashOrderTypeCoinRoll": [
            {
              "EntryId": 1,
              "CashOrderTypeCoinRoll": 1
            }
          ],
          "CashOrderTypeComment": [
            {
              "EntryId": 1,
              "CashOrderTypeComment": "text"
            }
          ],
          "CashOrderTypeCurrFit": [
            {
              "EntryId": 1,
              "CashOrderTypeCurrFit": 1
            }
          ],
          "CashOrderTypeCurrNew": [
            {
              "EntryId": 1,
              "CashOrderTypeCurrNew": 1
            }
          ],
          "CashOrderTypeDelCharge": 1,
          "CashOrderTypeMaxOrder": 1,
          "CashOrderTypeMinOrder": 1,
          "CashOrderTypeName": "text",
          "CashOrderTypeSpecDelCharge": 1,
          "CloseDate": "2025-05-21",
          "DelFrequency": 1,
          "DeliveryDays": [
            {
              "EntryId": 1,
              "DeliveryDays": 1
            }
          ],
          "LocationCode": "text",
          "Locator": 1,
          "OrderLimiting": 1,
          "RecordChangeDate": "2025-05-21",
          "SpecHandlingFee": 1,
          "VendorNumber": 1
        }
      ]
    }
  }
}

getSiteSelectFieldsFilterChildren

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

{
  "Credentials": {
    "UserNumberCredentials": {
      "UserNumber": 1995,
      "Password": "2dfKQYR!TeXJwe"
    }
  },
  "AccountNumber": "text",
  "SiteLocator": 1,
  "SelectableFields": {
    "IncludeAllSiteFields": true,
    "SiteFields": {
      "City": true,
      "CloseDate": true,
      "ContactPhone": true,
      "ExtraAddress": true,
      "FaxPhone": true,
      "Locator": true,
      "RecordChangeDate": true,
      "SiteContactName": true,
      "SiteId": true,
      "SiteName": true,
      "SiteNumber": true,
      "SiteSettleShareId": true,
      "State": true,
      "Street": true,
      "ZipCode": true
    },
    "SiteCashOrderTypeSelectableFields": {
      "IncludeAllSiteCashOrderTypeFields": true,
      "SiteCashOrderTypeFields": {
        "ActiveFlag": true,
        "ApplyHandlingFee": true,
        "CashOrderTypeCoinBag": [
          1
        ],
        "CashOrderTypeCoinRoll": [
          1
        ],
        "CashOrderTypeComment": [
          1
        ],
        "CashOrderTypeCurrFit": [
          1
        ],
        "CashOrderTypeCurrNew": [
          1
        ],
        "CashOrderTypeDelCharge": true,
        "CashOrderTypeMaxOrder": true,
        "CashOrderTypeMinOrder": true,
        "CashOrderTypeName": true,
        "CashOrderTypeSpecDelCharge": true,
        "CloseDate": true,
        "DelFrequency": true,
        "DeliveryDays": [
          1
        ],
        "LocationCode": true,
        "Locator": true,
        "OrderLimiting": true,
        "RecordChangeDate": true,
        "SpecHandlingFee": true,
        "VendorNumber": true
      }
    }
  },
  "ChildrenSearchFilter": {
    "SiteCashOrderTypeFilter": {
      "Query": "text"
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}
200

Successful operation.

{
  "Site": {
    "City": "text",
    "CloseDate": "2025-05-21",
    "ContactPhone": "text",
    "ExtraAddress": "text",
    "FaxPhone": "text",
    "Locator": 1,
    "RecordChangeDate": "2025-05-21",
    "SiteContactName": "text",
    "SiteId": "text",
    "SiteName": "text",
    "SiteNumber": 1,
    "SiteSettleShareId": "text",
    "State": "text",
    "Street": "text",
    "ZipCode": "text",
    "SiteCashOrderTypeList": {
      "hasReachedMaximumListSize": true,
      "SiteCashOrderType": [
        {
          "ActiveFlag": 1,
          "ApplyHandlingFee": 1,
          "CashOrderTypeCoinBag": [
            {
              "EntryId": 1,
              "CashOrderTypeCoinBag": 1
            }
          ],
          "CashOrderTypeCoinRoll": [
            {
              "EntryId": 1,
              "CashOrderTypeCoinRoll": 1
            }
          ],
          "CashOrderTypeComment": [
            {
              "EntryId": 1,
              "CashOrderTypeComment": "text"
            }
          ],
          "CashOrderTypeCurrFit": [
            {
              "EntryId": 1,
              "CashOrderTypeCurrFit": 1
            }
          ],
          "CashOrderTypeCurrNew": [
            {
              "EntryId": 1,
              "CashOrderTypeCurrNew": 1
            }
          ],
          "CashOrderTypeDelCharge": 1,
          "CashOrderTypeMaxOrder": 1,
          "CashOrderTypeMinOrder": 1,
          "CashOrderTypeName": "text",
          "CashOrderTypeSpecDelCharge": 1,
          "CloseDate": "2025-05-21",
          "DelFrequency": 1,
          "DeliveryDays": [
            {
              "EntryId": 1,
              "DeliveryDays": 1
            }
          ],
          "LocationCode": "text",
          "Locator": 1,
          "OrderLimiting": 1,
          "RecordChangeDate": "2025-05-21",
          "SpecHandlingFee": 1,
          "VendorNumber": 1
        }
      ]
    }
  }
}

getSitePagedList

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

{
  "Credentials": {
    "UserNumberCredentials": {
      "UserNumber": 1995,
      "Password": "2dfKQYR!TeXJwe"
    }
  },
  "AccountNumber": "text",
  "PagingRequestContext": {
    "NumberOfRecordsToReturn": 1,
    "NumberOfRecordsToSkip": 1,
    "Token": "text"
  },
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}
200

Successful operation.

{
  "Site": [
    {
      "City": "text",
      "CloseDate": "2025-05-21",
      "ContactPhone": "text",
      "ExtraAddress": "text",
      "FaxPhone": "text",
      "Locator": 1,
      "RecordChangeDate": "2025-05-21",
      "SiteContactName": "text",
      "SiteId": "text",
      "SiteName": "text",
      "SiteNumber": 1,
      "SiteSettleShareId": "text",
      "State": "text",
      "Street": "text",
      "ZipCode": "text",
      "SiteCashOrderTypeList": {
        "hasReachedMaximumListSize": true,
        "SiteCashOrderType": [
          {
            "ActiveFlag": 1,
            "ApplyHandlingFee": 1,
            "CashOrderTypeCoinBag": [
              {
                "EntryId": 1,
                "CashOrderTypeCoinBag": 1
              }
            ],
            "CashOrderTypeCoinRoll": [
              {
                "EntryId": 1,
                "CashOrderTypeCoinRoll": 1
              }
            ],
            "CashOrderTypeComment": [
              {
                "EntryId": 1,
                "CashOrderTypeComment": "text"
              }
            ],
            "CashOrderTypeCurrFit": [
              {
                "EntryId": 1,
                "CashOrderTypeCurrFit": 1
              }
            ],
            "CashOrderTypeCurrNew": [
              {
                "EntryId": 1,
                "CashOrderTypeCurrNew": 1
              }
            ],
            "CashOrderTypeDelCharge": 1,
            "CashOrderTypeMaxOrder": 1,
            "CashOrderTypeMinOrder": 1,
            "CashOrderTypeName": "text",
            "CashOrderTypeSpecDelCharge": 1,
            "CloseDate": "2025-05-21",
            "DelFrequency": 1,
            "DeliveryDays": [
              {
                "EntryId": 1,
                "DeliveryDays": 1
              }
            ],
            "LocationCode": "text",
            "Locator": 1,
            "OrderLimiting": 1,
            "RecordChangeDate": "2025-05-21",
            "SpecHandlingFee": 1,
            "VendorNumber": 1
          }
        ]
      }
    }
  ],
  "Token": "text"
}

getSiteListSelectFields

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

{
  "Credentials": {
    "UserNumberCredentials": {
      "UserNumber": 1995,
      "Password": "2dfKQYR!TeXJwe"
    }
  },
  "AccountNumber": "text",
  "SelectableFields": {
    "IncludeAllSiteFields": true,
    "SiteFields": {
      "City": true,
      "CloseDate": true,
      "ContactPhone": true,
      "ExtraAddress": true,
      "FaxPhone": true,
      "Locator": true,
      "RecordChangeDate": true,
      "SiteContactName": true,
      "SiteId": true,
      "SiteName": true,
      "SiteNumber": true,
      "SiteSettleShareId": true,
      "State": true,
      "Street": true,
      "ZipCode": true
    },
    "SiteCashOrderTypeSelectableFields": {
      "IncludeAllSiteCashOrderTypeFields": true,
      "SiteCashOrderTypeFields": {
        "ActiveFlag": true,
        "ApplyHandlingFee": true,
        "CashOrderTypeCoinBag": [
          1
        ],
        "CashOrderTypeCoinRoll": [
          1
        ],
        "CashOrderTypeComment": [
          1
        ],
        "CashOrderTypeCurrFit": [
          1
        ],
        "CashOrderTypeCurrNew": [
          1
        ],
        "CashOrderTypeDelCharge": true,
        "CashOrderTypeMaxOrder": true,
        "CashOrderTypeMinOrder": true,
        "CashOrderTypeName": true,
        "CashOrderTypeSpecDelCharge": true,
        "CloseDate": true,
        "DelFrequency": true,
        "DeliveryDays": [
          1
        ],
        "LocationCode": true,
        "Locator": true,
        "OrderLimiting": true,
        "RecordChangeDate": true,
        "SpecHandlingFee": true,
        "VendorNumber": true
      }
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}
200

Successful operation.

{
  "SiteList": {
    "hasReachedMaximumListSize": true,
    "Site": [
      {
        "City": "text",
        "CloseDate": "2025-05-21",
        "ContactPhone": "text",
        "ExtraAddress": "text",
        "FaxPhone": "text",
        "Locator": 1,
        "RecordChangeDate": "2025-05-21",
        "SiteContactName": "text",
        "SiteId": "text",
        "SiteName": "text",
        "SiteNumber": 1,
        "SiteSettleShareId": "text",
        "State": "text",
        "Street": "text",
        "ZipCode": "text",
        "SiteCashOrderTypeList": {
          "hasReachedMaximumListSize": true,
          "SiteCashOrderType": [
            {
              "ActiveFlag": 1,
              "ApplyHandlingFee": 1,
              "CashOrderTypeCoinBag": [
                {
                  "EntryId": 1,
                  "CashOrderTypeCoinBag": 1
                }
              ],
              "CashOrderTypeCoinRoll": [
                {
                  "EntryId": 1,
                  "CashOrderTypeCoinRoll": 1
                }
              ],
              "CashOrderTypeComment": [
                {
                  "EntryId": 1,
                  "CashOrderTypeComment": "text"
                }
              ],
              "CashOrderTypeCurrFit": [
                {
                  "EntryId": 1,
                  "CashOrderTypeCurrFit": 1
                }
              ],
              "CashOrderTypeCurrNew": [
                {
                  "EntryId": 1,
                  "CashOrderTypeCurrNew": 1
                }
              ],
              "CashOrderTypeDelCharge": 1,
              "CashOrderTypeMaxOrder": 1,
              "CashOrderTypeMinOrder": 1,
              "CashOrderTypeName": "text",
              "CashOrderTypeSpecDelCharge": 1,
              "CloseDate": "2025-05-21",
              "DelFrequency": 1,
              "DeliveryDays": [
                {
                  "EntryId": 1,
                  "DeliveryDays": 1
                }
              ],
              "LocationCode": "text",
              "Locator": 1,
              "OrderLimiting": 1,
              "RecordChangeDate": "2025-05-21",
              "SpecHandlingFee": 1,
              "VendorNumber": 1
            }
          ]
        }
      }
    ]
  }
}

searchSiteSelectFields

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

{
  "Credentials": {
    "UserNumberCredentials": {
      "UserNumber": 1995,
      "Password": "2dfKQYR!TeXJwe"
    }
  },
  "AccountNumber": "text",
  "SelectableFields": {
    "IncludeAllSiteFields": true,
    "SiteFields": {
      "City": true,
      "CloseDate": true,
      "ContactPhone": true,
      "ExtraAddress": true,
      "FaxPhone": true,
      "Locator": true,
      "RecordChangeDate": true,
      "SiteContactName": true,
      "SiteId": true,
      "SiteName": true,
      "SiteNumber": true,
      "SiteSettleShareId": true,
      "State": true,
      "Street": true,
      "ZipCode": true
    },
    "SiteCashOrderTypeSelectableFields": {
      "IncludeAllSiteCashOrderTypeFields": true,
      "SiteCashOrderTypeFields": {
        "ActiveFlag": true,
        "ApplyHandlingFee": true,
        "CashOrderTypeCoinBag": [
          1
        ],
        "CashOrderTypeCoinRoll": [
          1
        ],
        "CashOrderTypeComment": [
          1
        ],
        "CashOrderTypeCurrFit": [
          1
        ],
        "CashOrderTypeCurrNew": [
          1
        ],
        "CashOrderTypeDelCharge": true,
        "CashOrderTypeMaxOrder": true,
        "CashOrderTypeMinOrder": true,
        "CashOrderTypeName": true,
        "CashOrderTypeSpecDelCharge": true,
        "CloseDate": true,
        "DelFrequency": true,
        "DeliveryDays": [
          1
        ],
        "LocationCode": true,
        "Locator": true,
        "OrderLimiting": true,
        "RecordChangeDate": true,
        "SpecHandlingFee": true,
        "VendorNumber": true
      }
    }
  },
  "SearchFilter": {
    "Query": "text",
    "SiteChildrenFilter": {
      "SiteCashOrderTypeFilter": {
        "Query": "text"
      }
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}
200

Successful operation.

{
  "SiteList": {
    "hasReachedMaximumListSize": true,
    "Site": [
      {
        "City": "text",
        "CloseDate": "2025-05-21",
        "ContactPhone": "text",
        "ExtraAddress": "text",
        "FaxPhone": "text",
        "Locator": 1,
        "RecordChangeDate": "2025-05-21",
        "SiteContactName": "text",
        "SiteId": "text",
        "SiteName": "text",
        "SiteNumber": 1,
        "SiteSettleShareId": "text",
        "State": "text",
        "Street": "text",
        "ZipCode": "text",
        "SiteCashOrderTypeList": {
          "hasReachedMaximumListSize": true,
          "SiteCashOrderType": [
            {
              "ActiveFlag": 1,
              "ApplyHandlingFee": 1,
              "CashOrderTypeCoinBag": [
                {
                  "EntryId": 1,
                  "CashOrderTypeCoinBag": 1
                }
              ],
              "CashOrderTypeCoinRoll": [
                {
                  "EntryId": 1,
                  "CashOrderTypeCoinRoll": 1
                }
              ],
              "CashOrderTypeComment": [
                {
                  "EntryId": 1,
                  "CashOrderTypeComment": "text"
                }
              ],
              "CashOrderTypeCurrFit": [
                {
                  "EntryId": 1,
                  "CashOrderTypeCurrFit": 1
                }
              ],
              "CashOrderTypeCurrNew": [
                {
                  "EntryId": 1,
                  "CashOrderTypeCurrNew": 1
                }
              ],
              "CashOrderTypeDelCharge": 1,
              "CashOrderTypeMaxOrder": 1,
              "CashOrderTypeMinOrder": 1,
              "CashOrderTypeName": "text",
              "CashOrderTypeSpecDelCharge": 1,
              "CloseDate": "2025-05-21",
              "DelFrequency": 1,
              "DeliveryDays": [
                {
                  "EntryId": 1,
                  "DeliveryDays": 1
                }
              ],
              "LocationCode": "text",
              "Locator": 1,
              "OrderLimiting": 1,
              "RecordChangeDate": "2025-05-21",
              "SpecHandlingFee": 1,
              "VendorNumber": 1
            }
          ]
        }
      }
    ]
  }
}

getSitePagedListSelectFields

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

{
  "Credentials": {
    "UserNumberCredentials": {
      "UserNumber": 1995,
      "Password": "2dfKQYR!TeXJwe"
    }
  },
  "AccountNumber": "text",
  "PagingRequestContext": {
    "NumberOfRecordsToReturn": 1,
    "NumberOfRecordsToSkip": 1,
    "Token": "text"
  },
  "SelectableFields": {
    "IncludeAllSiteFields": true,
    "SiteFields": {
      "City": true,
      "CloseDate": true,
      "ContactPhone": true,
      "ExtraAddress": true,
      "FaxPhone": true,
      "Locator": true,
      "RecordChangeDate": true,
      "SiteContactName": true,
      "SiteId": true,
      "SiteName": true,
      "SiteNumber": true,
      "SiteSettleShareId": true,
      "State": true,
      "Street": true,
      "ZipCode": true
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}
200

Successful operation.

{
  "Site": [
    {
      "City": "text",
      "CloseDate": "2025-05-21",
      "ContactPhone": "text",
      "ExtraAddress": "text",
      "FaxPhone": "text",
      "Locator": 1,
      "RecordChangeDate": "2025-05-21",
      "SiteContactName": "text",
      "SiteId": "text",
      "SiteName": "text",
      "SiteNumber": 1,
      "SiteSettleShareId": "text",
      "State": "text",
      "Street": "text",
      "ZipCode": "text",
      "SiteCashOrderTypeList": {
        "hasReachedMaximumListSize": true,
        "SiteCashOrderType": [
          {
            "ActiveFlag": 1,
            "ApplyHandlingFee": 1,
            "CashOrderTypeCoinBag": [
              {
                "EntryId": 1,
                "CashOrderTypeCoinBag": 1
              }
            ],
            "CashOrderTypeCoinRoll": [
              {
                "EntryId": 1,
                "CashOrderTypeCoinRoll": 1
              }
            ],
            "CashOrderTypeComment": [
              {
                "EntryId": 1,
                "CashOrderTypeComment": "text"
              }
            ],
            "CashOrderTypeCurrFit": [
              {
                "EntryId": 1,
                "CashOrderTypeCurrFit": 1
              }
            ],
            "CashOrderTypeCurrNew": [
              {
                "EntryId": 1,
                "CashOrderTypeCurrNew": 1
              }
            ],
            "CashOrderTypeDelCharge": 1,
            "CashOrderTypeMaxOrder": 1,
            "CashOrderTypeMinOrder": 1,
            "CashOrderTypeName": "text",
            "CashOrderTypeSpecDelCharge": 1,
            "CloseDate": "2025-05-21",
            "DelFrequency": 1,
            "DeliveryDays": [
              {
                "EntryId": 1,
                "DeliveryDays": 1
              }
            ],
            "LocationCode": "text",
            "Locator": 1,
            "OrderLimiting": 1,
            "RecordChangeDate": "2025-05-21",
            "SpecHandlingFee": 1,
            "VendorNumber": 1
          }
        ]
      }
    }
  ],
  "Token": "text"
}

searchSitePagedSelectFields

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

{
  "Credentials": {
    "UserNumberCredentials": {
      "UserNumber": 1995,
      "Password": "2dfKQYR!TeXJwe"
    }
  },
  "AccountNumber": "text",
  "PagingRequestContext": {
    "NumberOfRecordsToReturn": 1,
    "NumberOfRecordsToSkip": 1,
    "Token": "text"
  },
  "SelectableFields": {
    "IncludeAllSiteFields": true,
    "SiteFields": {
      "City": true,
      "CloseDate": true,
      "ContactPhone": true,
      "ExtraAddress": true,
      "FaxPhone": true,
      "Locator": true,
      "RecordChangeDate": true,
      "SiteContactName": true,
      "SiteId": true,
      "SiteName": true,
      "SiteNumber": true,
      "SiteSettleShareId": true,
      "State": true,
      "Street": true,
      "ZipCode": true
    }
  },
  "Query": "text",
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}
200

Successful operation.

{
  "Site": [
    {
      "City": "text",
      "CloseDate": "2025-05-21",
      "ContactPhone": "text",
      "ExtraAddress": "text",
      "FaxPhone": "text",
      "Locator": 1,
      "RecordChangeDate": "2025-05-21",
      "SiteContactName": "text",
      "SiteId": "text",
      "SiteName": "text",
      "SiteNumber": 1,
      "SiteSettleShareId": "text",
      "State": "text",
      "Street": "text",
      "ZipCode": "text",
      "SiteCashOrderTypeList": {
        "hasReachedMaximumListSize": true,
        "SiteCashOrderType": [
          {
            "ActiveFlag": 1,
            "ApplyHandlingFee": 1,
            "CashOrderTypeCoinBag": [
              {
                "EntryId": 1,
                "CashOrderTypeCoinBag": 1
              }
            ],
            "CashOrderTypeCoinRoll": [
              {
                "EntryId": 1,
                "CashOrderTypeCoinRoll": 1
              }
            ],
            "CashOrderTypeComment": [
              {
                "EntryId": 1,
                "CashOrderTypeComment": "text"
              }
            ],
            "CashOrderTypeCurrFit": [
              {
                "EntryId": 1,
                "CashOrderTypeCurrFit": 1
              }
            ],
            "CashOrderTypeCurrNew": [
              {
                "EntryId": 1,
                "CashOrderTypeCurrNew": 1
              }
            ],
            "CashOrderTypeDelCharge": 1,
            "CashOrderTypeMaxOrder": 1,
            "CashOrderTypeMinOrder": 1,
            "CashOrderTypeName": "text",
            "CashOrderTypeSpecDelCharge": 1,
            "CloseDate": "2025-05-21",
            "DelFrequency": 1,
            "DeliveryDays": [
              {
                "EntryId": 1,
                "DeliveryDays": 1
              }
            ],
            "LocationCode": "text",
            "Locator": 1,
            "OrderLimiting": 1,
            "RecordChangeDate": "2025-05-21",
            "SpecHandlingFee": 1,
            "VendorNumber": 1
          }
        ]
      }
    }
  ],
  "Token": "text"
}

getSiteCashOrderType

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

{
  "Credentials": {
    "UserNumberCredentials": {
      "UserNumber": 1995,
      "Password": "2dfKQYR!TeXJwe"
    }
  },
  "AccountNumber": "text",
  "SiteLocator": 1,
  "SiteCashOrderTypeLocator": 1,
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}
200

Successful operation.

{
  "SiteCashOrderType": {
    "ActiveFlag": 1,
    "ApplyHandlingFee": 1,
    "CashOrderTypeCoinBag": [
      {
        "EntryId": 1,
        "CashOrderTypeCoinBag": 1
      }
    ],
    "CashOrderTypeCoinRoll": [
      {
        "EntryId": 1,
        "CashOrderTypeCoinRoll": 1
      }
    ],
    "CashOrderTypeComment": [
      {
        "EntryId": 1,
        "CashOrderTypeComment": "text"
      }
    ],
    "CashOrderTypeCurrFit": [
      {
        "EntryId": 1,
        "CashOrderTypeCurrFit": 1
      }
    ],
    "CashOrderTypeCurrNew": [
      {
        "EntryId": 1,
        "CashOrderTypeCurrNew": 1
      }
    ],
    "CashOrderTypeDelCharge": 1,
    "CashOrderTypeMaxOrder": 1,
    "CashOrderTypeMinOrder": 1,
    "CashOrderTypeName": "text",
    "CashOrderTypeSpecDelCharge": 1,
    "CloseDate": "2025-05-21",
    "DelFrequency": 1,
    "DeliveryDays": [
      {
        "EntryId": 1,
        "DeliveryDays": 1
      }
    ],
    "LocationCode": "text",
    "Locator": 1,
    "OrderLimiting": 1,
    "RecordChangeDate": "2025-05-21",
    "SpecHandlingFee": 1,
    "VendorNumber": 1
  }
}

getSiteCashOrderTypeSelectFields

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

{
  "Credentials": {
    "UserNumberCredentials": {
      "UserNumber": 1995,
      "Password": "2dfKQYR!TeXJwe"
    }
  },
  "AccountNumber": "text",
  "SiteLocator": 1,
  "SiteCashOrderTypeLocator": 1,
  "SelectableFields": {
    "IncludeAllSiteCashOrderTypeFields": true,
    "SiteCashOrderTypeFields": {
      "ActiveFlag": true,
      "ApplyHandlingFee": true,
      "CashOrderTypeCoinBag": [
        1
      ],
      "CashOrderTypeCoinRoll": [
        1
      ],
      "CashOrderTypeComment": [
        1
      ],
      "CashOrderTypeCurrFit": [
        1
      ],
      "CashOrderTypeCurrNew": [
        1
      ],
      "CashOrderTypeDelCharge": true,
      "CashOrderTypeMaxOrder": true,
      "CashOrderTypeMinOrder": true,
      "CashOrderTypeName": true,
      "CashOrderTypeSpecDelCharge": true,
      "CloseDate": true,
      "DelFrequency": true,
      "DeliveryDays": [
        1
      ],
      "LocationCode": true,
      "Locator": true,
      "OrderLimiting": true,
      "RecordChangeDate": true,
      "SpecHandlingFee": true,
      "VendorNumber": true
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}
200

Successful operation.

{
  "SiteCashOrderType": {
    "ActiveFlag": 1,
    "ApplyHandlingFee": 1,
    "CashOrderTypeCoinBag": [
      {
        "EntryId": 1,
        "CashOrderTypeCoinBag": 1
      }
    ],
    "CashOrderTypeCoinRoll": [
      {
        "EntryId": 1,
        "CashOrderTypeCoinRoll": 1
      }
    ],
    "CashOrderTypeComment": [
      {
        "EntryId": 1,
        "CashOrderTypeComment": "text"
      }
    ],
    "CashOrderTypeCurrFit": [
      {
        "EntryId": 1,
        "CashOrderTypeCurrFit": 1
      }
    ],
    "CashOrderTypeCurrNew": [
      {
        "EntryId": 1,
        "CashOrderTypeCurrNew": 1
      }
    ],
    "CashOrderTypeDelCharge": 1,
    "CashOrderTypeMaxOrder": 1,
    "CashOrderTypeMinOrder": 1,
    "CashOrderTypeName": "text",
    "CashOrderTypeSpecDelCharge": 1,
    "CloseDate": "2025-05-21",
    "DelFrequency": 1,
    "DeliveryDays": [
      {
        "EntryId": 1,
        "DeliveryDays": 1
      }
    ],
    "LocationCode": "text",
    "Locator": 1,
    "OrderLimiting": 1,
    "RecordChangeDate": "2025-05-21",
    "SpecHandlingFee": 1,
    "VendorNumber": 1
  }
}

getSiteCashOrderTypePagedList

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

{
  "Credentials": {
    "UserNumberCredentials": {
      "UserNumber": 1995,
      "Password": "2dfKQYR!TeXJwe"
    }
  },
  "AccountNumber": "text",
  "SiteLocator": 1,
  "PagingRequestContext": {
    "NumberOfRecordsToReturn": 1,
    "NumberOfRecordsToSkip": 1,
    "Token": "text"
  },
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}
200

Successful operation.

{
  "SiteCashOrderType": [
    {
      "ActiveFlag": 1,
      "ApplyHandlingFee": 1,
      "CashOrderTypeCoinBag": [
        {
          "EntryId": 1,
          "CashOrderTypeCoinBag": 1
        }
      ],
      "CashOrderTypeCoinRoll": [
        {
          "EntryId": 1,
          "CashOrderTypeCoinRoll": 1
        }
      ],
      "CashOrderTypeComment": [
        {
          "EntryId": 1,
          "CashOrderTypeComment": "text"
        }
      ],
      "CashOrderTypeCurrFit": [
        {
          "EntryId": 1,
          "CashOrderTypeCurrFit": 1
        }
      ],
      "CashOrderTypeCurrNew": [
        {
          "EntryId": 1,
          "CashOrderTypeCurrNew": 1
        }
      ],
      "CashOrderTypeDelCharge": 1,
      "CashOrderTypeMaxOrder": 1,
      "CashOrderTypeMinOrder": 1,
      "CashOrderTypeName": "text",
      "CashOrderTypeSpecDelCharge": 1,
      "CloseDate": "2025-05-21",
      "DelFrequency": 1,
      "DeliveryDays": [
        {
          "EntryId": 1,
          "DeliveryDays": 1
        }
      ],
      "LocationCode": "text",
      "Locator": 1,
      "OrderLimiting": 1,
      "RecordChangeDate": "2025-05-21",
      "SpecHandlingFee": 1,
      "VendorNumber": 1
    }
  ],
  "Token": "text"
}

getSiteCashOrderTypeListSelectFields

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

{
  "Credentials": {
    "UserNumberCredentials": {
      "UserNumber": 1995,
      "Password": "2dfKQYR!TeXJwe"
    }
  },
  "AccountNumber": "text",
  "SiteLocator": 1,
  "SelectableFields": {
    "IncludeAllSiteCashOrderTypeFields": true,
    "SiteCashOrderTypeFields": {
      "ActiveFlag": true,
      "ApplyHandlingFee": true,
      "CashOrderTypeCoinBag": [
        1
      ],
      "CashOrderTypeCoinRoll": [
        1
      ],
      "CashOrderTypeComment": [
        1
      ],
      "CashOrderTypeCurrFit": [
        1
      ],
      "CashOrderTypeCurrNew": [
        1
      ],
      "CashOrderTypeDelCharge": true,
      "CashOrderTypeMaxOrder": true,
      "CashOrderTypeMinOrder": true,
      "CashOrderTypeName": true,
      "CashOrderTypeSpecDelCharge": true,
      "CloseDate": true,
      "DelFrequency": true,
      "DeliveryDays": [
        1
      ],
      "LocationCode": true,
      "Locator": true,
      "OrderLimiting": true,
      "RecordChangeDate": true,
      "SpecHandlingFee": true,
      "VendorNumber": true
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}
200

Successful operation.

{
  "SiteCashOrderTypeList": {
    "hasReachedMaximumListSize": true,
    "SiteCashOrderType": [
      {
        "ActiveFlag": 1,
        "ApplyHandlingFee": 1,
        "CashOrderTypeCoinBag": [
          {
            "EntryId": 1,
            "CashOrderTypeCoinBag": 1
          }
        ],
        "CashOrderTypeCoinRoll": [
          {
            "EntryId": 1,
            "CashOrderTypeCoinRoll": 1
          }
        ],
        "CashOrderTypeComment": [
          {
            "EntryId": 1,
            "CashOrderTypeComment": "text"
          }
        ],
        "CashOrderTypeCurrFit": [
          {
            "EntryId": 1,
            "CashOrderTypeCurrFit": 1
          }
        ],
        "CashOrderTypeCurrNew": [
          {
            "EntryId": 1,
            "CashOrderTypeCurrNew": 1
          }
        ],
        "CashOrderTypeDelCharge": 1,
        "CashOrderTypeMaxOrder": 1,
        "CashOrderTypeMinOrder": 1,
        "CashOrderTypeName": "text",
        "CashOrderTypeSpecDelCharge": 1,
        "CloseDate": "2025-05-21",
        "DelFrequency": 1,
        "DeliveryDays": [
          {
            "EntryId": 1,
            "DeliveryDays": 1
          }
        ],
        "LocationCode": "text",
        "Locator": 1,
        "OrderLimiting": 1,
        "RecordChangeDate": "2025-05-21",
        "SpecHandlingFee": 1,
        "VendorNumber": 1
      }
    ]
  }
}

searchSiteCashOrderTypeSelectFields

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

{
  "Credentials": {
    "UserNumberCredentials": {
      "UserNumber": 1995,
      "Password": "2dfKQYR!TeXJwe"
    }
  },
  "AccountNumber": "text",
  "SiteLocator": 1,
  "SelectableFields": {
    "IncludeAllSiteCashOrderTypeFields": true,
    "SiteCashOrderTypeFields": {
      "ActiveFlag": true,
      "ApplyHandlingFee": true,
      "CashOrderTypeCoinBag": [
        1
      ],
      "CashOrderTypeCoinRoll": [
        1
      ],
      "CashOrderTypeComment": [
        1
      ],
      "CashOrderTypeCurrFit": [
        1
      ],
      "CashOrderTypeCurrNew": [
        1
      ],
      "CashOrderTypeDelCharge": true,
      "CashOrderTypeMaxOrder": true,
      "CashOrderTypeMinOrder": true,
      "CashOrderTypeName": true,
      "CashOrderTypeSpecDelCharge": true,
      "CloseDate": true,
      "DelFrequency": true,
      "DeliveryDays": [
        1
      ],
      "LocationCode": true,
      "Locator": true,
      "OrderLimiting": true,
      "RecordChangeDate": true,
      "SpecHandlingFee": true,
      "VendorNumber": true
    }
  },
  "SearchFilter": {
    "Query": "text"
  },
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}
200

Successful operation.

{
  "SiteCashOrderTypeList": {
    "hasReachedMaximumListSize": true,
    "SiteCashOrderType": [
      {
        "ActiveFlag": 1,
        "ApplyHandlingFee": 1,
        "CashOrderTypeCoinBag": [
          {
            "EntryId": 1,
            "CashOrderTypeCoinBag": 1
          }
        ],
        "CashOrderTypeCoinRoll": [
          {
            "EntryId": 1,
            "CashOrderTypeCoinRoll": 1
          }
        ],
        "CashOrderTypeComment": [
          {
            "EntryId": 1,
            "CashOrderTypeComment": "text"
          }
        ],
        "CashOrderTypeCurrFit": [
          {
            "EntryId": 1,
            "CashOrderTypeCurrFit": 1
          }
        ],
        "CashOrderTypeCurrNew": [
          {
            "EntryId": 1,
            "CashOrderTypeCurrNew": 1
          }
        ],
        "CashOrderTypeDelCharge": 1,
        "CashOrderTypeMaxOrder": 1,
        "CashOrderTypeMinOrder": 1,
        "CashOrderTypeName": "text",
        "CashOrderTypeSpecDelCharge": 1,
        "CloseDate": "2025-05-21",
        "DelFrequency": 1,
        "DeliveryDays": [
          {
            "EntryId": 1,
            "DeliveryDays": 1
          }
        ],
        "LocationCode": "text",
        "Locator": 1,
        "OrderLimiting": 1,
        "RecordChangeDate": "2025-05-21",
        "SpecHandlingFee": 1,
        "VendorNumber": 1
      }
    ]
  }
}

getSiteCashOrderTypePagedListSelectFields

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

{
  "Credentials": {
    "UserNumberCredentials": {
      "UserNumber": 1995,
      "Password": "2dfKQYR!TeXJwe"
    }
  },
  "AccountNumber": "text",
  "SiteLocator": 1,
  "PagingRequestContext": {
    "NumberOfRecordsToReturn": 1,
    "NumberOfRecordsToSkip": 1,
    "Token": "text"
  },
  "SelectableFields": {
    "IncludeAllSiteCashOrderTypeFields": true,
    "SiteCashOrderTypeFields": {
      "ActiveFlag": true,
      "ApplyHandlingFee": true,
      "CashOrderTypeCoinBag": [
        1
      ],
      "CashOrderTypeCoinRoll": [
        1
      ],
      "CashOrderTypeComment": [
        1
      ],
      "CashOrderTypeCurrFit": [
        1
      ],
      "CashOrderTypeCurrNew": [
        1
      ],
      "CashOrderTypeDelCharge": true,
      "CashOrderTypeMaxOrder": true,
      "CashOrderTypeMinOrder": true,
      "CashOrderTypeName": true,
      "CashOrderTypeSpecDelCharge": true,
      "CloseDate": true,
      "DelFrequency": true,
      "DeliveryDays": [
        1
      ],
      "LocationCode": true,
      "Locator": true,
      "OrderLimiting": true,
      "RecordChangeDate": true,
      "SpecHandlingFee": true,
      "VendorNumber": true
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}
200

Successful operation.

{
  "SiteCashOrderType": [
    {
      "ActiveFlag": 1,
      "ApplyHandlingFee": 1,
      "CashOrderTypeCoinBag": [
        {
          "EntryId": 1,
          "CashOrderTypeCoinBag": 1
        }
      ],
      "CashOrderTypeCoinRoll": [
        {
          "EntryId": 1,
          "CashOrderTypeCoinRoll": 1
        }
      ],
      "CashOrderTypeComment": [
        {
          "EntryId": 1,
          "CashOrderTypeComment": "text"
        }
      ],
      "CashOrderTypeCurrFit": [
        {
          "EntryId": 1,
          "CashOrderTypeCurrFit": 1
        }
      ],
      "CashOrderTypeCurrNew": [
        {
          "EntryId": 1,
          "CashOrderTypeCurrNew": 1
        }
      ],
      "CashOrderTypeDelCharge": 1,
      "CashOrderTypeMaxOrder": 1,
      "CashOrderTypeMinOrder": 1,
      "CashOrderTypeName": "text",
      "CashOrderTypeSpecDelCharge": 1,
      "CloseDate": "2025-05-21",
      "DelFrequency": 1,
      "DeliveryDays": [
        {
          "EntryId": 1,
          "DeliveryDays": 1
        }
      ],
      "LocationCode": "text",
      "Locator": 1,
      "OrderLimiting": 1,
      "RecordChangeDate": "2025-05-21",
      "SpecHandlingFee": 1,
      "VendorNumber": 1
    }
  ],
  "Token": "text"
}

searchSiteCashOrderTypePagedSelectFields

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

{
  "Credentials": {
    "UserNumberCredentials": {
      "UserNumber": 1995,
      "Password": "2dfKQYR!TeXJwe"
    }
  },
  "AccountNumber": "text",
  "SiteLocator": 1,
  "PagingRequestContext": {
    "NumberOfRecordsToReturn": 1,
    "NumberOfRecordsToSkip": 1,
    "Token": "text"
  },
  "SelectableFields": {
    "IncludeAllSiteCashOrderTypeFields": true,
    "SiteCashOrderTypeFields": {
      "ActiveFlag": true,
      "ApplyHandlingFee": true,
      "CashOrderTypeCoinBag": [
        1
      ],
      "CashOrderTypeCoinRoll": [
        1
      ],
      "CashOrderTypeComment": [
        1
      ],
      "CashOrderTypeCurrFit": [
        1
      ],
      "CashOrderTypeCurrNew": [
        1
      ],
      "CashOrderTypeDelCharge": true,
      "CashOrderTypeMaxOrder": true,
      "CashOrderTypeMinOrder": true,
      "CashOrderTypeName": true,
      "CashOrderTypeSpecDelCharge": true,
      "CloseDate": true,
      "DelFrequency": true,
      "DeliveryDays": [
        1
      ],
      "LocationCode": true,
      "Locator": true,
      "OrderLimiting": true,
      "RecordChangeDate": true,
      "SpecHandlingFee": true,
      "VendorNumber": true
    }
  },
  "Query": "text",
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}
200

Successful operation.

{
  "SiteCashOrderType": [
    {
      "ActiveFlag": 1,
      "ApplyHandlingFee": 1,
      "CashOrderTypeCoinBag": [
        {
          "EntryId": 1,
          "CashOrderTypeCoinBag": 1
        }
      ],
      "CashOrderTypeCoinRoll": [
        {
          "EntryId": 1,
          "CashOrderTypeCoinRoll": 1
        }
      ],
      "CashOrderTypeComment": [
        {
          "EntryId": 1,
          "CashOrderTypeComment": "text"
        }
      ],
      "CashOrderTypeCurrFit": [
        {
          "EntryId": 1,
          "CashOrderTypeCurrFit": 1
        }
      ],
      "CashOrderTypeCurrNew": [
        {
          "EntryId": 1,
          "CashOrderTypeCurrNew": 1
        }
      ],
      "CashOrderTypeDelCharge": 1,
      "CashOrderTypeMaxOrder": 1,
      "CashOrderTypeMinOrder": 1,
      "CashOrderTypeName": "text",
      "CashOrderTypeSpecDelCharge": 1,
      "CloseDate": "2025-05-21",
      "DelFrequency": 1,
      "DeliveryDays": [
        {
          "EntryId": 1,
          "DeliveryDays": 1
        }
      ],
      "LocationCode": "text",
      "Locator": 1,
      "OrderLimiting": 1,
      "RecordChangeDate": "2025-05-21",
      "SpecHandlingFee": 1,
      "VendorNumber": 1
    }
  ],
  "Token": "text"
}

updateSiteByID

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

{
  "Credentials": {
    "UserNumberCredentials": {
      "UserNumber": 1995,
      "Password": "2dfKQYR!TeXJwe"
    }
  },
  "SiteLocator": 1,
  "SiteUpdatableFields": {
    "City": "text",
    "CloseDate": "2025-05-21",
    "ContactPhone": "text",
    "ExtraAddress": "text",
    "FaxPhone": "text",
    "SiteContactName": "text",
    "SiteId": "text",
    "SiteName": "text",
    "SiteNumber": 1,
    "SiteSettleShareId": "text",
    "State": "text",
    "Street": "text",
    "ZipCode": "text"
  },
  "SiteCashOrderTypeUpdateRequest": [
    {
      "SiteCashOrderTypeLocator": 1,
      "SiteCashOrderTypeUpdatableFields": {
        "ActiveFlag": 1,
        "ApplyHandlingFee": 1,
        "CashOrderTypeCoinBag": [
          {
            "EntryId": 1,
            "CashOrderTypeCoinBag": 1
          }
        ],
        "CashOrderTypeCoinRoll": [
          {
            "EntryId": 1,
            "CashOrderTypeCoinRoll": 1
          }
        ],
        "CashOrderTypeComment": [
          {
            "EntryId": 1,
            "CashOrderTypeComment": "text"
          }
        ],
        "CashOrderTypeCurrFit": [
          {
            "EntryId": 1,
            "CashOrderTypeCurrFit": 1
          }
        ],
        "CashOrderTypeCurrNew": [
          {
            "EntryId": 1,
            "CashOrderTypeCurrNew": 1
          }
        ],
        "CashOrderTypeDelCharge": 1,
        "CashOrderTypeMaxOrder": 1,
        "CashOrderTypeMinOrder": 1,
        "CashOrderTypeName": "text",
        "CashOrderTypeSpecDelCharge": 1,
        "CloseDate": "2025-05-21",
        "DelFrequency": 1,
        "DeliveryDays": [
          {
            "EntryId": 1,
            "DeliveryDays": 1
          }
        ],
        "LocationCode": "text",
        "OrderLimiting": 1,
        "VendorNumber": 1
      }
    }
  ],
  "AccountNumber": "text",
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}
200

Successful operation.

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

updateSiteCashOrderTypeByID

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

{
  "Credentials": {
    "UserNumberCredentials": {
      "UserNumber": 1995,
      "Password": "2dfKQYR!TeXJwe"
    }
  },
  "SiteCashOrderTypeLocator": 1,
  "SiteCashOrderTypeUpdatableFields": {
    "ActiveFlag": 1,
    "ApplyHandlingFee": 1,
    "CashOrderTypeCoinBag": [
      {
        "EntryId": 1,
        "CashOrderTypeCoinBag": 1
      }
    ],
    "CashOrderTypeCoinRoll": [
      {
        "EntryId": 1,
        "CashOrderTypeCoinRoll": 1
      }
    ],
    "CashOrderTypeComment": [
      {
        "EntryId": 1,
        "CashOrderTypeComment": "text"
      }
    ],
    "CashOrderTypeCurrFit": [
      {
        "EntryId": 1,
        "CashOrderTypeCurrFit": 1
      }
    ],
    "CashOrderTypeCurrNew": [
      {
        "EntryId": 1,
        "CashOrderTypeCurrNew": 1
      }
    ],
    "CashOrderTypeDelCharge": 1,
    "CashOrderTypeMaxOrder": 1,
    "CashOrderTypeMinOrder": 1,
    "CashOrderTypeName": "text",
    "CashOrderTypeSpecDelCharge": 1,
    "CloseDate": "2025-05-21",
    "DelFrequency": 1,
    "DeliveryDays": [
      {
        "EntryId": 1,
        "DeliveryDays": 1
      }
    ],
    "LocationCode": "text",
    "OrderLimiting": 1,
    "VendorNumber": 1
  },
  "AccountNumber": "text",
  "SiteLocator": 1,
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}
200

Successful operation.

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

createSite

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

{
  "Credentials": {
    "UserNumberCredentials": {
      "UserNumber": 1995,
      "Password": "2dfKQYR!TeXJwe"
    }
  },
  "SiteCreatableFields": {
    "City": "text",
    "CloseDate": "2025-05-21",
    "ContactPhone": "text",
    "ExtraAddress": "text",
    "FaxPhone": "text",
    "SiteContactName": "text",
    "SiteId": "text",
    "SiteName": "text",
    "SiteNumber": 1,
    "SiteSettleShareId": "text",
    "State": "text",
    "Street": "text",
    "ZipCode": "text"
  },
  "AccountNumber": "text",
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}
200

Successful operation.

{
  "SiteLocator": 1
}

createSiteCashOrderType

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

{
  "Credentials": {
    "UserNumberCredentials": {
      "UserNumber": 1995,
      "Password": "2dfKQYR!TeXJwe"
    }
  },
  "SiteCashOrderTypeCreatableFields": {
    "ActiveFlag": 1,
    "ApplyHandlingFee": 1,
    "CashOrderTypeCoinBag": [
      {
        "EntryId": 1,
        "CashOrderTypeCoinBag": 1
      }
    ],
    "CashOrderTypeCoinRoll": [
      {
        "EntryId": 1,
        "CashOrderTypeCoinRoll": 1
      }
    ],
    "CashOrderTypeComment": [
      {
        "EntryId": 1,
        "CashOrderTypeComment": "text"
      }
    ],
    "CashOrderTypeCurrFit": [
      {
        "EntryId": 1,
        "CashOrderTypeCurrFit": 1
      }
    ],
    "CashOrderTypeCurrNew": [
      {
        "EntryId": 1,
        "CashOrderTypeCurrNew": 1
      }
    ],
    "CashOrderTypeDelCharge": 1,
    "CashOrderTypeMaxOrder": 1,
    "CashOrderTypeMinOrder": 1,
    "CashOrderTypeName": "text",
    "CashOrderTypeSpecDelCharge": 1,
    "CloseDate": "2025-05-21",
    "DelFrequency": 1,
    "DeliveryDays": [
      {
        "EntryId": 1,
        "DeliveryDays": 1
      }
    ],
    "LocationCode": "text",
    "OrderLimiting": 1,
    "VendorNumber": 1
  },
  "AccountNumber": "text",
  "SiteLocator": 1,
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}
200

Successful operation.

{
  "SiteCashOrderTypeLocator": 1
}