LoadFileUploadRequest

  • checksum
    Type: string
    required

    MD5 hex digest of the raw (pre-encoding) file bytes, used for integrity verification

  • content
    Type: string
    required

    Base64-encoded file bytes

  • contentType
    Type: string
    required

    MIME type of the file. Supported values: application/pdf, image/jpeg, image/png, image/heic, image/webp, image/tiff

  • filename
    Type: string
    required

    Original filename including extension. Supported extensions: .pdf, .jpg, .jpeg, .png, .heic, .webp, .tiff, .tif

  • fileType
    Type: stringenum
    required

    The category of the document being uploaded

    values
    • INVOICE
    • POD
    • BOL
    • RATE_CONFIRMATION
    • LUMPER_RECEIPT
    • OTHER
  • loadNum
    Type: string
    required

    The load's external number in the TMS (brokerageLoadId)

  • sizeBytes
    Type: integer
    required

    File size in bytes

  • createdAt
    Type: string

    ISO 8601 timestamp of when the document was collected/created

  • internalLoadReference
    Type: string

    Optional internal load identifier from the TMS (brokerageLoadInternalId). Only included when available.

  • referenceNumbers
    Type: object
    • invoiceNumber
      Type: string

      Required when fileType is INVOICE

  • source
    Type: object

    Origin of the document, used by some brokerages for routing (e.g. carrier ID)

    • identifier
      Type: string
      required

      The identifier value (e.g. MC number, SCAC code, email address)

    • identifierType
      Type: stringenum
      required

      How the source entity is identified

      values
      • MC_NUMBER
      • DOT_NUMBER
      • SCAC
      • EMAIL
      • NAME
      • EXTERNAL_ID
    • type
      Type: stringenum
      required

      The kind of entity that provided the document

      values
      • CARRIER
      • BROKER
      • SHIPPER
      • CONSIGNEE
      • DRIVER
      • OTHER
    • name
      Type: string

      Optional display name for the source entity