API Docs
YMS API
Data Models
Receipt View

ReceiptView

{
  "id": 0,
  "receiptId": "string",
  "receiptStatus": "string",
  "receiptType": "string",
  "poNo": "string",
  "carrierId": "string",
  "customerId": "string",
  "referenceNo": "string",
  "equipmentType": "string",
  "equipmentNo": "string",
  "totalPalletQty": 0,
  "itemLines": [
    {
      "itemId": "string",
      "itemName": "string",
      "itemQty": "string",
      "palletQty": "string",
      "itemSpecDesc": "string",
      "itemSpecName": "string",
      "uomId": "string",
      "qty": "string"
    }
  ],
  "appointmentTime": "string",
  "appointmentId": "string",
  "sealNo": "string",
  "dataChannel": "YMS",
  "eventTime": "string",
  "extraData": "string",
  "carrierName": "string",
  "customerName": "string",
  "dynamicFieldValues": [
    {
      "entityId": "string",
      "entityType": "RECEIPT",
      "fieldCode": "string",
      "value": "string",
      "fieldName": "string",
      "longValue": "string",
      "shortValue": "string"
    }
  ],
  "proNos": [
    "string"
  ],
  "invoicePros": [
    "string"
  ],
  "doNos": [
    "string"
  ],
  "tripNo": "string"
}
 

Properties

NameTypeRequiredConstraintsChinese NameDescription
idinteger(int64)falsenoneID
receiptIdstringfalsenoneReceipt ID (RN-xxx)
receiptStatusstringfalsenoneReceipt status
receiptTypestringfalsenoneReceipt type
poNostringfalsenonePurchase order number
carrierIdstringfalsenoneCarrier ID
customerIdstringfalsenoneCustomer ID
referenceNostringfalsenoneReference number
equipmentTypestringfalsenoneEquipment type
equipmentNostringfalsenoneEquipment number
totalPalletQtyintegerfalsenoneTotal pallet quantity
itemLines[ItemInfo (opens in a new tab)]falsenoneItem information list
appointmentTimestringfalsenoneAppointment time
appointmentIdstringfalsenoneAppointment ID
sealNostringfalsenonenone
dataChannelstringfalsenoneData source channel
eventTimestringfalsenoneEvent time for idempotency control
extraDatastringfalsenoneExtra data in JSON format
carrierNamestringfalsenoneCarrier name
customerNamestringfalsenoneCustomer name
dynamicFieldValues[DynamicFieldValueView (opens in a new tab)]falsenoneDynamic field values
proNos[string]falsenonenone
invoicePros[string]falsenonenone
doNos[string]falsenonenone
tripNostringfalsenonenone

Enum Values

PropertyValue
dataChannelYMS
dataChannelWMS
dataChannelOMS
dataChannelTMS
dataChannelFMS