GET api/HCS?empid={empid}&soptype={soptype}&sopnumbe={sopnumbe}

Request Information

URI Parameters

Name	Type	Additional information
empid	integer	Required
soptype	integer	Required
sopnumbe	string	Required

Body Parameters

None.

Response Information

Resource Description

HCSInvoiceCriteria

Name	Type	Additional information
EmpId	integer	None.
BegDate	date	None.
EndDate	date	None.
CustNmbr	string	None.
SOPTYPE	integer	None.
SOPNUMBE	string	None.
CUSTNMBR	string	None.
CUSTNAME	string	None.
CSTPONBR	string	None.
ReqShipDate	date	None.
DOCDATE	date	None.
DocType	string	None.
DocStatus	string	None.
Container	string	None.
Seal	string	None.
NotifyFirst	string	None.
NotifyLast	string	None.
NotifyAddress1	string	None.
NotifyAddress2	string	None.
NotifyCity	string	None.
NotifyState	string	None.
NotifyZip	string	None.
IncoTerms	string	None.
PackingSlipReady	boolean	None.
ORIGTYPE	integer	None.
ORIGNUMB	string	None.
LoadNmbr	string	None.
ContTareWeight	decimal number	None.
PalletWeight	decimal number	None.
PackagingWeight	decimal number	None.
ProductWeight	decimal number	None.
ConfirmationSigned	boolean	None.
ConfirmationSignature	string	None.
ConfirmationSignDate	date	None.
BookingNumber	string	None.
orderlines	Collection of OrderLines	None.
SupplierRefNumber	string	None.
CarrierName	string	None.
CarrierSCACCode	string	None.
CarrierBookingNumber	string	None.
WeighingMethod	string	None.
WeightsUofM	string	None.
ShipmentRefNumber	string	None.
ModeOfTransportation	string	None.
PortOfExport	string	None.
PortOfUnlading	string	None.
DepartureDate	date	None.
ExportInformationCode	string	None.
OriginState	string	None.
CountryOfDestination	string	None.
RoutedTransaction	boolean	None.
RelatedCompanies	boolean	None.
HazardousCargo	boolean	None.
LicenseTypeCode	string	None.
USPPI_EIN	string	None.
UltimateConsigneeType	string	None.
InBondCode	string	None.
IntermediateConsignee	string	None.
FreightForwarder	string	None.
ConveyanceName	string	None.
VoyageNumber	string	None.
EquipmentNumber	string	None.
Urgency	string	None.
PreparerName	string	None.
VesselName	string	None.
EstimatedArrivalDate	date	None.

Response Formats

application/json, text/json

Sample:

{
  "EmpId": 1,
  "BegDate": "2025-12-14T20:07:26.2963551+00:00",
  "EndDate": "2025-12-14T20:07:26.2963551+00:00",
  "CustNmbr": "sample string 4",
  "SOPTYPE": 5,
  "SOPNUMBE": "sample string 6",
  "CUSTNMBR": "sample string 7",
  "CUSTNAME": "sample string 8",
  "CSTPONBR": "sample string 9",
  "ReqShipDate": "2025-12-14T20:07:26.2963551+00:00",
  "DOCDATE": "2025-12-14T20:07:26.2963551+00:00",
  "DocType": "sample string 12",
  "DocStatus": "sample string 13",
  "Container": "sample string 14",
  "Seal": "sample string 15",
  "NotifyFirst": "sample string 16",
  "NotifyLast": "sample string 17",
  "NotifyAddress1": "sample string 18",
  "NotifyAddress2": "sample string 19",
  "NotifyCity": "sample string 20",
  "NotifyState": "sample string 21",
  "NotifyZip": "sample string 22",
  "IncoTerms": "sample string 23",
  "PackingSlipReady": true,
  "ORIGTYPE": 25,
  "ORIGNUMB": "sample string 26",
  "LoadNmbr": "sample string 27",
  "ContTareWeight": 28.1,
  "PalletWeight": 29.1,
  "PackagingWeight": 30.1,
  "ProductWeight": 31.1,
  "ConfirmationSigned": true,
  "ConfirmationSignature": "sample string 33",
  "ConfirmationSignDate": "2025-12-14T20:07:26.2963551+00:00",
  "BookingNumber": "sample string 35",
  "orderlines": [
    {
      "LNITMSEQ": 1,
      "ITEMNMBR": "sample string 2",
      "ITEMDESC": "sample string 3",
      "QUANTITY": 4.1,
      "UOFM": "sample string 5",
      "HTSCode": "sample string 6",
      "ECCN": "sample string 7",
      "HarmonizeCode": "sample string 8"
    },
    {
      "LNITMSEQ": 1,
      "ITEMNMBR": "sample string 2",
      "ITEMDESC": "sample string 3",
      "QUANTITY": 4.1,
      "UOFM": "sample string 5",
      "HTSCode": "sample string 6",
      "ECCN": "sample string 7",
      "HarmonizeCode": "sample string 8"
    }
  ],
  "SupplierRefNumber": "sample string 36",
  "CarrierName": "sample string 37",
  "CarrierSCACCode": "sample string 38",
  "CarrierBookingNumber": "sample string 39",
  "WeighingMethod": "sample string 40",
  "WeightsUofM": "sample string 41",
  "ShipmentRefNumber": "sample string 42",
  "ModeOfTransportation": "sample string 43",
  "PortOfExport": "sample string 44",
  "PortOfUnlading": "sample string 45",
  "DepartureDate": "2025-12-14T20:07:26.3119514+00:00",
  "ExportInformationCode": "sample string 47",
  "OriginState": "sample string 48",
  "CountryOfDestination": "sample string 49",
  "RoutedTransaction": true,
  "RelatedCompanies": true,
  "HazardousCargo": true,
  "LicenseTypeCode": "sample string 53",
  "USPPI_EIN": "sample string 54",
  "UltimateConsigneeType": "sample string 55",
  "InBondCode": "sample string 56",
  "IntermediateConsignee": "sample string 57",
  "FreightForwarder": "sample string 58",
  "ConveyanceName": "sample string 59",
  "VoyageNumber": "sample string 60",
  "EquipmentNumber": "sample string 61",
  "Urgency": "sample string 62",
  "PreparerName": "sample string 63",
  "VesselName": "sample string 64",
  "EstimatedArrivalDate": "2025-12-14T20:07:26.3119514+00:00"
}

application/xml, text/xml

Sample:

<HCSInvoiceCriteria xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/HCSAPI.DTOs">
  <BegDate>2025-12-14T20:07:26.2963551+00:00</BegDate>
  <BookingNumber>sample string 35</BookingNumber>
  <CSTPONBR>sample string 9</CSTPONBR>
  <CUSTNAME>sample string 8</CUSTNAME>
  <CUSTNMBR>sample string 7</CUSTNMBR>
  <CarrierBookingNumber>sample string 39</CarrierBookingNumber>
  <CarrierName>sample string 37</CarrierName>
  <CarrierSCACCode>sample string 38</CarrierSCACCode>
  <ConfirmationSignDate>2025-12-14T20:07:26.2963551+00:00</ConfirmationSignDate>
  <ConfirmationSignature>sample string 33</ConfirmationSignature>
  <ConfirmationSigned>true</ConfirmationSigned>
  <ContTareWeight>28.1</ContTareWeight>
  <Container>sample string 14</Container>
  <ConveyanceName>sample string 59</ConveyanceName>
  <CountryOfDestination>sample string 49</CountryOfDestination>
  <CustNmbr>sample string 4</CustNmbr>
  <DOCDATE>2025-12-14T20:07:26.2963551+00:00</DOCDATE>
  <DepartureDate>2025-12-14T20:07:26.3119514+00:00</DepartureDate>
  <DocStatus>sample string 13</DocStatus>
  <DocType>sample string 12</DocType>
  <EmpId>1</EmpId>
  <EndDate>2025-12-14T20:07:26.2963551+00:00</EndDate>
  <EquipmentNumber>sample string 61</EquipmentNumber>
  <EstimatedArrivalDate>2025-12-14T20:07:26.3119514+00:00</EstimatedArrivalDate>
  <ExportInformationCode>sample string 47</ExportInformationCode>
  <FreightForwarder>sample string 58</FreightForwarder>
  <HazardousCargo>true</HazardousCargo>
  <InBondCode>sample string 56</InBondCode>
  <IncoTerms>sample string 23</IncoTerms>
  <IntermediateConsignee>sample string 57</IntermediateConsignee>
  <LicenseTypeCode>sample string 53</LicenseTypeCode>
  <LoadNmbr>sample string 27</LoadNmbr>
  <ModeOfTransportation>sample string 43</ModeOfTransportation>
  <NotifyAddress1>sample string 18</NotifyAddress1>
  <NotifyAddress2>sample string 19</NotifyAddress2>
  <NotifyCity>sample string 20</NotifyCity>
  <NotifyFirst>sample string 16</NotifyFirst>
  <NotifyLast>sample string 17</NotifyLast>
  <NotifyState>sample string 21</NotifyState>
  <NotifyZip>sample string 22</NotifyZip>
  <ORIGNUMB>sample string 26</ORIGNUMB>
  <ORIGTYPE>25</ORIGTYPE>
  <OriginState>sample string 48</OriginState>
  <PackagingWeight>30.1</PackagingWeight>
  <PackingSlipReady>true</PackingSlipReady>
  <PalletWeight>29.1</PalletWeight>
  <PortOfExport>sample string 44</PortOfExport>
  <PortOfUnlading>sample string 45</PortOfUnlading>
  <PreparerName>sample string 63</PreparerName>
  <ProductWeight>31.1</ProductWeight>
  <RelatedCompanies>true</RelatedCompanies>
  <ReqShipDate>2025-12-14T20:07:26.2963551+00:00</ReqShipDate>
  <RoutedTransaction>true</RoutedTransaction>
  <SOPNUMBE>sample string 6</SOPNUMBE>
  <SOPTYPE>5</SOPTYPE>
  <Seal>sample string 15</Seal>
  <ShipmentRefNumber>sample string 42</ShipmentRefNumber>
  <SupplierRefNumber>sample string 36</SupplierRefNumber>
  <USPPI_EIN>sample string 54</USPPI_EIN>
  <UltimateConsigneeType>sample string 55</UltimateConsigneeType>
  <Urgency>sample string 62</Urgency>
  <VesselName>sample string 64</VesselName>
  <VoyageNumber>sample string 60</VoyageNumber>
  <WeighingMethod>sample string 40</WeighingMethod>
  <WeightsUofM>sample string 41</WeightsUofM>
  <orderlines>
    <OrderLines>
      <ECCN>sample string 7</ECCN>
      <HTSCode>sample string 6</HTSCode>
      <HarmonizeCode>sample string 8</HarmonizeCode>
      <ITEMDESC>sample string 3</ITEMDESC>
      <ITEMNMBR>sample string 2</ITEMNMBR>
      <LNITMSEQ>1</LNITMSEQ>
      <QUANTITY>4.1</QUANTITY>
      <UOFM>sample string 5</UOFM>
    </OrderLines>
    <OrderLines>
      <ECCN>sample string 7</ECCN>
      <HTSCode>sample string 6</HTSCode>
      <HarmonizeCode>sample string 8</HarmonizeCode>
      <ITEMDESC>sample string 3</ITEMDESC>
      <ITEMNMBR>sample string 2</ITEMNMBR>
      <LNITMSEQ>1</LNITMSEQ>
      <QUANTITY>4.1</QUANTITY>
      <UOFM>sample string 5</UOFM>
    </OrderLines>
  </orderlines>
</HCSInvoiceCriteria>