Site

Perform various operations on site records.

Symitar eDocs References: Coming soon.

Operations

getSite

post

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

AccountNumberstringOptional

SiteLocatorintegerOptional

Responses

200

Successful operation.

application/json

post/getSite

HTTPcURLJavaScriptPython

POST /nexum/627/2022.01/account/getSite HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 359

{
  "Credentials": {
    "AccountNumberCredentials": {},
    "HomeBankingCredentials": {},
    "CardCredentials": {},
    "MICRCredentials": {},
    "LookupCredentials": {},
    "UserNumberCredentials": {
      "UserNumber": 1,
      "Password": "text"
    },
    "AdministrativeCredentials": {
      "Password": "text"
    },
    "TokenCredentials": {
      "TokenId": "text"
    }
  },
  "AccountNumber": "text",
  "SiteLocator": 1,
  "nxAttributes": {
    "customFields": {}
  }
}

200

Successful operation.

{
  "Site": {
    "City": "text",
    "CloseDate": "2026-07-11",
    "ContactPhone": "text",
    "ExtraAddress": "text",
    "FaxPhone": "text",
    "Locator": 1,
    "RecordChangeDate": "2026-07-11",
    "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": "2026-07-11",
          "DelFrequency": 1,
          "DeliveryDays": [
            {
              "EntryId": 1,
              "DeliveryDays": 1
            }
          ],
          "LocationCode": "text",
          "Locator": 1,
          "OrderLimiting": 1,
          "RecordChangeDate": "2026-07-11",
          "SpecHandlingFee": 1,
          "VendorNumber": 1
        }
      ]
    }
  }
}

getSiteSelectFields

post

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

AccountNumberstringOptional

SiteLocatorintegerOptional

Responses

200

Successful operation.

application/json

post/getSiteSelectFields

HTTPcURLJavaScriptPython

POST /nexum/627/2022.01/account/getSiteSelectFields HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 1296

{
  "Credentials": {
    "AccountNumberCredentials": {},
    "HomeBankingCredentials": {},
    "CardCredentials": {},
    "MICRCredentials": {},
    "LookupCredentials": {},
    "UserNumberCredentials": {
      "UserNumber": 1,
      "Password": "text"
    },
    "AdministrativeCredentials": {
      "Password": "text"
    },
    "TokenCredentials": {
      "TokenId": "text"
    }
  },
  "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": {}
  }
}

200

Successful operation.

{
  "Site": {
    "City": "text",
    "CloseDate": "2026-07-11",
    "ContactPhone": "text",
    "ExtraAddress": "text",
    "FaxPhone": "text",
    "Locator": 1,
    "RecordChangeDate": "2026-07-11",
    "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": "2026-07-11",
          "DelFrequency": 1,
          "DeliveryDays": [
            {
              "EntryId": 1,
              "DeliveryDays": 1
            }
          ],
          "LocationCode": "text",
          "Locator": 1,
          "OrderLimiting": 1,
          "RecordChangeDate": "2026-07-11",
          "SpecHandlingFee": 1,
          "VendorNumber": 1
        }
      ]
    }
  }
}

getSiteSelectFieldsFilterChildren

post

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

AccountNumberstringOptional

SiteLocatorintegerOptional

Responses

200

Successful operation.

application/json

post/getSiteSelectFieldsFilterChildren

HTTPcURLJavaScriptPython

POST /nexum/627/2022.01/account/getSiteSelectFieldsFilterChildren HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 1364

{
  "Credentials": {
    "AccountNumberCredentials": {},
    "HomeBankingCredentials": {},
    "CardCredentials": {},
    "MICRCredentials": {},
    "LookupCredentials": {},
    "UserNumberCredentials": {
      "UserNumber": 1,
      "Password": "text"
    },
    "AdministrativeCredentials": {
      "Password": "text"
    },
    "TokenCredentials": {
      "TokenId": "text"
    }
  },
  "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": {}
  }
}

200

Successful operation.

{
  "Site": {
    "City": "text",
    "CloseDate": "2026-07-11",
    "ContactPhone": "text",
    "ExtraAddress": "text",
    "FaxPhone": "text",
    "Locator": 1,
    "RecordChangeDate": "2026-07-11",
    "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": "2026-07-11",
          "DelFrequency": 1,
          "DeliveryDays": [
            {
              "EntryId": 1,
              "DeliveryDays": 1
            }
          ],
          "LocationCode": "text",
          "Locator": 1,
          "OrderLimiting": 1,
          "RecordChangeDate": "2026-07-11",
          "SpecHandlingFee": 1,
          "VendorNumber": 1
        }
      ]
    }
  }
}

getSitePagedList

post

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

AccountNumberstringOptional

Responses

200

Successful operation.

application/json

TokenstringOptional

post/getSitePagedList

HTTPcURLJavaScriptPython

POST /nexum/627/2022.01/account/getSitePagedList HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 437

{
  "Credentials": {
    "AccountNumberCredentials": {},
    "HomeBankingCredentials": {},
    "CardCredentials": {},
    "MICRCredentials": {},
    "LookupCredentials": {},
    "UserNumberCredentials": {
      "UserNumber": 1,
      "Password": "text"
    },
    "AdministrativeCredentials": {
      "Password": "text"
    },
    "TokenCredentials": {
      "TokenId": "text"
    }
  },
  "AccountNumber": "text",
  "PagingRequestContext": {
    "NumberOfRecordsToReturn": 1,
    "NumberOfRecordsToSkip": 1,
    "Token": "text"
  },
  "nxAttributes": {
    "customFields": {}
  }
}

200

Successful operation.

{
  "Site": [
    {
      "City": "text",
      "CloseDate": "2026-07-11",
      "ContactPhone": "text",
      "ExtraAddress": "text",
      "FaxPhone": "text",
      "Locator": 1,
      "RecordChangeDate": "2026-07-11",
      "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": "2026-07-11",
            "DelFrequency": 1,
            "DeliveryDays": [
              {
                "EntryId": 1,
                "DeliveryDays": 1
              }
            ],
            "LocationCode": "text",
            "Locator": 1,
            "OrderLimiting": 1,
            "RecordChangeDate": "2026-07-11",
            "SpecHandlingFee": 1,
            "VendorNumber": 1
          }
        ]
      }
    }
  ],
  "Token": "text"
}

getSiteListSelectFields

post

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

AccountNumberstringOptional

Responses

200

Successful operation.

application/json

post/getSiteListSelectFields

HTTPcURLJavaScriptPython

POST /nexum/627/2022.01/account/getSiteListSelectFields HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 1280

{
  "Credentials": {
    "AccountNumberCredentials": {},
    "HomeBankingCredentials": {},
    "CardCredentials": {},
    "MICRCredentials": {},
    "LookupCredentials": {},
    "UserNumberCredentials": {
      "UserNumber": 1,
      "Password": "text"
    },
    "AdministrativeCredentials": {
      "Password": "text"
    },
    "TokenCredentials": {
      "TokenId": "text"
    }
  },
  "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": {}
  }
}

200

Successful operation.

{
  "SiteList": {
    "hasReachedMaximumListSize": true,
    "Site": [
      {
        "City": "text",
        "CloseDate": "2026-07-11",
        "ContactPhone": "text",
        "ExtraAddress": "text",
        "FaxPhone": "text",
        "Locator": 1,
        "RecordChangeDate": "2026-07-11",
        "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": "2026-07-11",
              "DelFrequency": 1,
              "DeliveryDays": [
                {
                  "EntryId": 1,
                  "DeliveryDays": 1
                }
              ],
              "LocationCode": "text",
              "Locator": 1,
              "OrderLimiting": 1,
              "RecordChangeDate": "2026-07-11",
              "SpecHandlingFee": 1,
              "VendorNumber": 1
            }
          ]
        }
      }
    ]
  }
}

searchSiteSelectFields

post

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

AccountNumberstringOptional

Responses

200

Successful operation.

application/json

post/searchSiteSelectFields

HTTPcURLJavaScriptPython

POST /nexum/627/2022.01/account/searchSiteSelectFields HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 1378

{
  "Credentials": {
    "AccountNumberCredentials": {},
    "HomeBankingCredentials": {},
    "CardCredentials": {},
    "MICRCredentials": {},
    "LookupCredentials": {},
    "UserNumberCredentials": {
      "UserNumber": 1,
      "Password": "text"
    },
    "AdministrativeCredentials": {
      "Password": "text"
    },
    "TokenCredentials": {
      "TokenId": "text"
    }
  },
  "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": {}
  }
}

200

Successful operation.

{
  "SiteList": {
    "hasReachedMaximumListSize": true,
    "Site": [
      {
        "City": "text",
        "CloseDate": "2026-07-11",
        "ContactPhone": "text",
        "ExtraAddress": "text",
        "FaxPhone": "text",
        "Locator": 1,
        "RecordChangeDate": "2026-07-11",
        "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": "2026-07-11",
              "DelFrequency": 1,
              "DeliveryDays": [
                {
                  "EntryId": 1,
                  "DeliveryDays": 1
                }
              ],
              "LocationCode": "text",
              "Locator": 1,
              "OrderLimiting": 1,
              "RecordChangeDate": "2026-07-11",
              "SpecHandlingFee": 1,
              "VendorNumber": 1
            }
          ]
        }
      }
    ]
  }
}

getSitePagedListSelectFields

post

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

AccountNumberstringOptional

Responses

200

Successful operation.

application/json

TokenstringOptional

post/getSitePagedListSelectFields

HTTPcURLJavaScriptPython

POST /nexum/627/2022.01/account/getSitePagedListSelectFields HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 442

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": {
        "symx-administrative-password": null
      }
    }
  },
  "AccountNumber": "0000013454",
  "PagingRequestContext": {
    "NumberOfRecordsToReturn": 5,
    "NumberOfRecordsToSkip": 0
  },
  "SelectableFields": {
    "IncludeAllSiteFields": false,
    "SiteFields": {
      "Locator": true,
      "SiteId": true,
      "SiteName": true,
      "SiteNumber": true,
      "City": true,
      "State": true,
      "RecordChangeDate": true
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "{application-id}"
    }
  }
}

200

Successful operation.

{
  "Site": [],
  "Token": null,
  "MessageId": "getSitePagedListSelectFields"
}

searchSitePagedSelectFields

post

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

AccountNumberstringOptional

QuerystringOptional

Responses

200

Successful operation.

application/json

TokenstringOptional

post/searchSitePagedSelectFields

HTTPcURLJavaScriptPython

POST /nexum/627/2022.01/account/searchSitePagedSelectFields HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 462

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": {
        "symx-administrative-password": null
      }
    }
  },
  "AccountNumber": "0000013454",
  "Query": "LOCATOR=0",
  "PagingRequestContext": {
    "NumberOfRecordsToReturn": 5,
    "NumberOfRecordsToSkip": 0
  },
  "SelectableFields": {
    "IncludeAllSiteFields": false,
    "SiteFields": {
      "Locator": true,
      "SiteId": true,
      "SiteName": true,
      "SiteNumber": true,
      "City": true,
      "State": true,
      "RecordChangeDate": true
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "{application-id}"
    }
  }
}

200

Successful operation.

{
  "Site": [],
  "Token": null,
  "MessageId": "searchSitePagedSelectFields"
}

getSiteCashOrderType

post

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

AccountNumberstringOptional

SiteLocatorintegerOptional

SiteCashOrderTypeLocatorintegerOptional

Responses

200

Successful operation.

application/json

post/getSiteCashOrderType

HTTPcURLJavaScriptPython

POST /nexum/627/2022.01/account/getSiteCashOrderType HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 388

{
  "Credentials": {
    "AccountNumberCredentials": {},
    "HomeBankingCredentials": {},
    "CardCredentials": {},
    "MICRCredentials": {},
    "LookupCredentials": {},
    "UserNumberCredentials": {
      "UserNumber": 1,
      "Password": "text"
    },
    "AdministrativeCredentials": {
      "Password": "text"
    },
    "TokenCredentials": {
      "TokenId": "text"
    }
  },
  "AccountNumber": "text",
  "SiteLocator": 1,
  "SiteCashOrderTypeLocator": 1,
  "nxAttributes": {
    "customFields": {}
  }
}

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": "2026-07-11",
    "DelFrequency": 1,
    "DeliveryDays": [
      {
        "EntryId": 1,
        "DeliveryDays": 1
      }
    ],
    "LocationCode": "text",
    "Locator": 1,
    "OrderLimiting": 1,
    "RecordChangeDate": "2026-07-11",
    "SpecHandlingFee": 1,
    "VendorNumber": 1
  }
}

getSiteCashOrderTypeSelectFields

post

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

AccountNumberstringOptional

SiteLocatorintegerOptional

SiteCashOrderTypeLocatorintegerOptional

Responses

200

Successful operation.

application/json

post/getSiteCashOrderTypeSelectFields

HTTPcURLJavaScriptPython

POST /nexum/627/2022.01/account/getSiteCashOrderTypeSelectFields HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 982

{
  "Credentials": {
    "AccountNumberCredentials": {},
    "HomeBankingCredentials": {},
    "CardCredentials": {},
    "MICRCredentials": {},
    "LookupCredentials": {},
    "UserNumberCredentials": {
      "UserNumber": 1,
      "Password": "text"
    },
    "AdministrativeCredentials": {
      "Password": "text"
    },
    "TokenCredentials": {
      "TokenId": "text"
    }
  },
  "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": {}
  }
}

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": "2026-07-11",
    "DelFrequency": 1,
    "DeliveryDays": [
      {
        "EntryId": 1,
        "DeliveryDays": 1
      }
    ],
    "LocationCode": "text",
    "Locator": 1,
    "OrderLimiting": 1,
    "RecordChangeDate": "2026-07-11",
    "SpecHandlingFee": 1,
    "VendorNumber": 1
  }
}

getSiteCashOrderTypePagedList

post

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

AccountNumberstringOptional

SiteLocatorintegerOptional

Responses

200

Successful operation.

application/json

TokenstringOptional

post/getSiteCashOrderTypePagedList

HTTPcURLJavaScriptPython

POST /nexum/627/2022.01/account/getSiteCashOrderTypePagedList HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 453

{
  "Credentials": {
    "AccountNumberCredentials": {},
    "HomeBankingCredentials": {},
    "CardCredentials": {},
    "MICRCredentials": {},
    "LookupCredentials": {},
    "UserNumberCredentials": {
      "UserNumber": 1,
      "Password": "text"
    },
    "AdministrativeCredentials": {
      "Password": "text"
    },
    "TokenCredentials": {
      "TokenId": "text"
    }
  },
  "AccountNumber": "text",
  "SiteLocator": 1,
  "PagingRequestContext": {
    "NumberOfRecordsToReturn": 1,
    "NumberOfRecordsToSkip": 1,
    "Token": "text"
  },
  "nxAttributes": {
    "customFields": {}
  }
}

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": "2026-07-11",
      "DelFrequency": 1,
      "DeliveryDays": [
        {
          "EntryId": 1,
          "DeliveryDays": 1
        }
      ],
      "LocationCode": "text",
      "Locator": 1,
      "OrderLimiting": 1,
      "RecordChangeDate": "2026-07-11",
      "SpecHandlingFee": 1,
      "VendorNumber": 1
    }
  ],
  "Token": "text"
}

getSiteCashOrderTypeListSelectFields

post

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

AccountNumberstringOptional

SiteLocatorintegerOptional

Responses

200

Successful operation.

application/json

post/getSiteCashOrderTypeListSelectFields

HTTPcURLJavaScriptPython

POST /nexum/627/2022.01/account/getSiteCashOrderTypeListSelectFields HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 953

{
  "Credentials": {
    "AccountNumberCredentials": {},
    "HomeBankingCredentials": {},
    "CardCredentials": {},
    "MICRCredentials": {},
    "LookupCredentials": {},
    "UserNumberCredentials": {
      "UserNumber": 1,
      "Password": "text"
    },
    "AdministrativeCredentials": {
      "Password": "text"
    },
    "TokenCredentials": {
      "TokenId": "text"
    }
  },
  "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": {}
  }
}

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": "2026-07-11",
        "DelFrequency": 1,
        "DeliveryDays": [
          {
            "EntryId": 1,
            "DeliveryDays": 1
          }
        ],
        "LocationCode": "text",
        "Locator": 1,
        "OrderLimiting": 1,
        "RecordChangeDate": "2026-07-11",
        "SpecHandlingFee": 1,
        "VendorNumber": 1
      }
    ]
  }
}

searchSiteCashOrderTypeSelectFields

post

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

AccountNumberstringOptional

SiteLocatorintegerOptional

Responses

200

Successful operation.

application/json

post/searchSiteCashOrderTypeSelectFields

HTTPcURLJavaScriptPython

POST /nexum/627/2022.01/account/searchSiteCashOrderTypeSelectFields HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 985

{
  "Credentials": {
    "AccountNumberCredentials": {},
    "HomeBankingCredentials": {},
    "CardCredentials": {},
    "MICRCredentials": {},
    "LookupCredentials": {},
    "UserNumberCredentials": {
      "UserNumber": 1,
      "Password": "text"
    },
    "AdministrativeCredentials": {
      "Password": "text"
    },
    "TokenCredentials": {
      "TokenId": "text"
    }
  },
  "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": {}
  }
}

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": "2026-07-11",
        "DelFrequency": 1,
        "DeliveryDays": [
          {
            "EntryId": 1,
            "DeliveryDays": 1
          }
        ],
        "LocationCode": "text",
        "Locator": 1,
        "OrderLimiting": 1,
        "RecordChangeDate": "2026-07-11",
        "SpecHandlingFee": 1,
        "VendorNumber": 1
      }
    ]
  }
}

getSiteCashOrderTypePagedListSelectFields

post

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

AccountNumberstringOptional

SiteLocatorintegerOptional

Responses

200

Successful operation.

application/json

TokenstringOptional

post/getSiteCashOrderTypePagedListSelectFields

HTTPcURLJavaScriptPython

POST /nexum/627/2022.01/account/getSiteCashOrderTypePagedListSelectFields HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 1047

{
  "Credentials": {
    "AccountNumberCredentials": {},
    "HomeBankingCredentials": {},
    "CardCredentials": {},
    "MICRCredentials": {},
    "LookupCredentials": {},
    "UserNumberCredentials": {
      "UserNumber": 1,
      "Password": "text"
    },
    "AdministrativeCredentials": {
      "Password": "text"
    },
    "TokenCredentials": {
      "TokenId": "text"
    }
  },
  "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": {}
  }
}

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": "2026-07-11",
      "DelFrequency": 1,
      "DeliveryDays": [
        {
          "EntryId": 1,
          "DeliveryDays": 1
        }
      ],
      "LocationCode": "text",
      "Locator": 1,
      "OrderLimiting": 1,
      "RecordChangeDate": "2026-07-11",
      "SpecHandlingFee": 1,
      "VendorNumber": 1
    }
  ],
  "Token": "text"
}

searchSiteCashOrderTypePagedSelectFields

post

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

AccountNumberstringOptional

SiteLocatorintegerOptional

QuerystringOptional

Responses

200

Successful operation.

application/json

TokenstringOptional

post/searchSiteCashOrderTypePagedSelectFields

HTTPcURLJavaScriptPython

POST /nexum/627/2022.01/account/searchSiteCashOrderTypePagedSelectFields HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 1062

{
  "Credentials": {
    "AccountNumberCredentials": {},
    "HomeBankingCredentials": {},
    "CardCredentials": {},
    "MICRCredentials": {},
    "LookupCredentials": {},
    "UserNumberCredentials": {
      "UserNumber": 1,
      "Password": "text"
    },
    "AdministrativeCredentials": {
      "Password": "text"
    },
    "TokenCredentials": {
      "TokenId": "text"
    }
  },
  "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": {}
  }
}

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": "2026-07-11",
      "DelFrequency": 1,
      "DeliveryDays": [
        {
          "EntryId": 1,
          "DeliveryDays": 1
        }
      ],
      "LocationCode": "text",
      "Locator": 1,
      "OrderLimiting": 1,
      "RecordChangeDate": "2026-07-11",
      "SpecHandlingFee": 1,
      "VendorNumber": 1
    }
  ],
  "Token": "text"
}

updateSiteByID

post

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

SiteLocatorintegerOptional

AccountNumberstringOptional

Responses

200

Successful operation.

application/jsonschema

post/updateSiteByID

HTTPcURLJavaScriptPython

POST /nexum/627/2022.01/account/updateSiteByID HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 335

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": {
        "symx-administrative-password": null
      }
    }
  },
  "AccountNumber": "0000013824",
  "SiteLocator": 284,
  "SiteUpdatableFields": {
    "SiteName": "NEXUM W4 2022 SITE UPDATED",
    "Street": "1 TEST WAY",
    "City": "TEST",
    "State": "TX",
    "ZipCode": "75001"
  },
  "nxAttributes": {
    "customFields": {
      "appId": "{application-id}"
    }
  }
}

200

Successful operation.

{
  "UpdateStatus": {
    "isAllFieldsUpdateSuccess": true,
    "FailedUpdateStatus": []
  },
  "MessageId": "updateSiteByID"
}

updateSiteCashOrderTypeByID

post

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

SiteCashOrderTypeLocatorintegerOptional

AccountNumberstringOptional

SiteLocatorintegerOptional

Responses

200

Successful operation.

application/json

post/updateSiteCashOrderTypeByID

HTTPcURLJavaScriptPython

POST /nexum/627/2022.01/account/updateSiteCashOrderTypeByID HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 307

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": {
        "symx-administrative-password": null
      }
    }
  },
  "SiteCashOrderTypeLocator": 1,
  "SiteCashOrderTypeUpdatableFields": {
    "Type": 0,
    "Description": "NEXUM EXAMPLE"
  },
  "AccountNumber": "0000013824",
  "SiteLocator": 1,
  "nxAttributes": {
    "customFields": {
      "appId": "{application-id}"
    }
  }
}

200

Successful operation.

{
  "UpdateStatus": {
    "isAllFieldsUpdateSuccess": true,
    "FailedUpdateStatus": []
  },
  "MessageId": "updateSiteCashOrderTypeByID"
}

createSite

post

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

AccountNumberstringOptional

Responses

200

Successful operation.

application/jsonschema

post/createSite

HTTPcURLJavaScriptPython

POST /nexum/627/2022.01/account/createSite HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 340

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": {
        "symx-administrative-password": null
      }
    }
  },
  "AccountNumber": "0000013824",
  "SiteCreatableFields": {
    "SiteId": "NW4B",
    "SiteName": "NEXUM W4 2022 SITE",
    "SiteNumber": 2,
    "Street": "1 TEST WAY",
    "City": "TEST",
    "State": "TX",
    "ZipCode": "75001"
  },
  "nxAttributes": {
    "customFields": {
      "appId": "{application-id}"
    }
  }
}

200

Successful operation.

{
  "SiteLocator": 284,
  "MessageId": "createSite"
}

createSiteCashOrderType

post

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

AccountNumberstringOptional

SiteLocatorintegerOptional

Responses

200

Successful operation.

application/json

SiteCashOrderTypeLocatorintegerOptional

post/createSiteCashOrderType

HTTPcURLJavaScriptPython

POST /nexum/627/2022.01/account/createSiteCashOrderType HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 278

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": {
        "symx-administrative-password": null
      }
    }
  },
  "SiteCashOrderTypeCreatableFields": {
    "Type": 0,
    "Description": "NEXUM EXAMPLE"
  },
  "AccountNumber": "0000013824",
  "SiteLocator": 1,
  "nxAttributes": {
    "customFields": {
      "appId": "{application-id}"
    }
  }
}

200

Successful operation.

{
  "SiteCashOrderTypeLocator": 1,
  "MessageId": "createSiteCashOrderType"
}