API Docs
YMS API
Data Models
Receipt
Receipt Query

ReceiptQuery

{
  "currentPage": 0,
  "pageSize": 0,
  "sortingFields": [
    {
      "field": "string",
      "orderBy": "NONE"
    }
  ],
  "receiptId": "string",
  "receiptIdLike": "string",
  "receiptIds": [
    "string"
  ],
  "receiptStatus": "string",
  "receiptStatuses": [
    "string"
  ],
  "excludeStatuses": [
    "string"
  ],
  "receiptType": "REGULAR_RECEIPT",
  "poNo": "string",
  "poNoLike": "string",
  "orPoNo": "string",
  "orReferenceNo": "string",
  "orId": "string",
  "carrierId": "string",
  "carrierIds": [
    "string"
  ],
  "customerId": "string",
  "customerIds": [
    "string"
  ],
  "equipmentNo": "string",
  "equipmentNos": [
    "string"
  ],
  "appointmentTimePeriod": [
    "string"
  ],
  "appointmentId": "string",
  "sealNo": "string",
  "referenceNo": "string",
  "referenceNoLike": "string",
  "referenceNos": [
    "string"
  ],
  "keyword": "string",
  "appointmentIdIsNull": true,
  "inYardTimeIsNull": true,
  "templateReceiptKey": "string",
  "searchScenario": "string"
}
 

Properties

NameTypeRequiredConstraintsChinese NameDescription
currentPageintegerfalsenonenone
pageSizeintegerfalsenonenone
sortingFields[SortingField (opens in a new tab)]falsenonenone
receiptIdstringfalsenoneReceipt ID
receiptIdLikestringfalsenonenone
receiptIds[string]falsenoneReceipt IDs
receiptStatusstringfalsenoneReceipt status
receiptStatuses[string]falsenoneReceipt statuses
excludeStatuses[string]falsenonenone
receiptTypestringfalsenoneReceipt type
poNostringfalsenonePurchase order number
poNoLikestringfalsenonenone
orPoNostringfalsenonenone
orReferenceNostringfalsenonenone
orIdstringfalsenonenone
carrierIdstringfalsenoneCarrier ID
carrierIds[string]falsenoneCarrier ID
customerIdstringfalsenoneCustomer ID
customerIds[string]falsenonenone
equipmentNostringfalsenoneEquipment number
equipmentNos[string]falsenoneequipmentNo in
appointmentTimePeriod[string]falsenoneAppointment time range start
appointmentIdstringfalsenoneAppointment ID
sealNostringfalsenoneSeal number
referenceNostringfalsenonenone
referenceNoLikestringfalsenonenone
referenceNos[string]falsenonenone
keywordstringfalsenonenone
appointmentIdIsNullbooleanfalsenonenone
inYardTimeIsNullbooleanfalsenonenone
templateReceiptKeystringfalsenonenone
searchScenariostringfalsenonenone

Enum Values

PropertyValue
receiptTypeREGULAR_RECEIPT
receiptTypeMATERIAL_RECEIVE
receiptTypeRETURN