InventoryService

Retrieve inventory records.

Symitar eDocs References: Coming soon.

Operations

getInventorySelectFields

Retrieves the inventory with selected fields.

POSThttps://naas.ymcu.libum.io/nexum/627/persistent/inventory/getInventorySelectFields

Authorization

bearerAuth

Body

application/json

Credentials*object

The authorization object required for the operation. Only one credential type is required (if multiple are available) as long as it is configured in SymXchange parameters.

InventoryGlobalSequenceDatestring (date)

InventoryGlobalSequenceinteger

SelectableFieldsobject

nxAttributes*object

The custom object for NexumAPI request attributes.

Response

200

Successful operation.

Body

application/json

Inventoryobject

Request

JavaScriptCurlPython

const response = await fetch('https://naas.ymcu.libum.io/nexum/627/persistent/inventory/getInventorySelectFields', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer JWT",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "Credentials": {
        "AdministrativeCredentials": {
          "Password": "suwn37834b91&"
        }
      },
      "nxAttributes": {
        "customFields": {
          "appId": "glaci"
        }
      }
    }),
});
const data = await response.json();

Response

200

{
  "Inventory": {
    "AccountNumber": "text",
    "ActualFeeAmount": 0,
    "ActualSaleAmount": 0,
    "Branch": 0,
    "City": "text",
    "Cost": 0,
    "ExtraAddress": "text",
    "FaceValue": 0,
    "GlobalSequence": 0,
    "GlobalSequenceDate": "2025-01-15",
    "Id": "text",
    "IdType": 0,
    "InStockDate": "2025-01-15",
    "LocationCode": "text",
    "Name": "text",
    "Price": 0,
    "Quantity": 0,
    "RecordChangeDate": "2025-01-15",
    "SaleRentalDate": "2025-01-15",
    "SbAcqAccount": "text",
    "SbAcqRAndTNumber": "text",
    "SequenceNumber": 0,
    "SerialNumber": "text",
    "StandardFee": 0,
    "State": "text",
    "Status": 0,
    "StatusDate": "2025-01-15",
    "Street": "text",
    "TermFrequency": 0,
    "TermPeriod": 0,
    "ThroughDate": "2025-01-15",
    "TransmissionDate": "2025-01-15",
    "Type": 0,
    "UserAmount1": 0,
    "UserAmount10": 0,
    "UserAmount2": 0,
    "UserAmount3": 0,
    "UserAmount4": 0,
    "UserAmount5": 0,
    "UserAmount6": 0,
    "UserAmount7": 0,
    "UserAmount8": 0,
    "UserAmount9": 0,
    "UserChar1": "text",
    "UserChar10": "text",
    "UserChar2": "text",
    "UserChar3": "text",
    "UserChar4": "text",
    "UserChar5": "text",
    "UserChar6": "text",
    "UserChar7": "text",
    "UserChar8": "text",
    "UserChar9": "text",
    "UserCode1": 0,
    "UserCode10": 0,
    "UserCode2": 0,
    "UserCode3": 0,
    "UserCode4": 0,
    "UserCode5": 0,
    "UserCode6": 0,
    "UserCode7": 0,
    "UserCode8": 0,
    "UserCode9": 0,
    "UserDate1": "2025-01-15",
    "UserDate10": "2025-01-15",
    "UserDate2": "2025-01-15",
    "UserDate3": "2025-01-15",
    "UserDate4": "2025-01-15",
    "UserDate5": "2025-01-15",
    "UserDate6": "2025-01-15",
    "UserDate7": "2025-01-15",
    "UserDate8": "2025-01-15",
    "UserDate9": "2025-01-15",
    "UserId": 0,
    "UserNumber1": 0,
    "UserNumber10": 0,
    "UserNumber2": 0,
    "UserNumber3": 0,
    "UserNumber4": 0,
    "UserNumber5": 0,
    "UserNumber6": 0,
    "UserNumber7": 0,
    "UserNumber8": 0,
    "UserNumber9": 0,
    "UserRate1": 0,
    "UserRate10": 0,
    "UserRate2": 0,
    "UserRate3": 0,
    "UserRate4": 0,
    "UserRate5": 0,
    "UserRate6": 0,
    "UserRate7": 0,
    "UserRate8": 0,
    "UserRate9": 0,
    "VoidDate": "2025-01-15",
    "ZipCode": "text"
  }
}