POST api/HCS/GetSalesAnalysisDetail

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
EmpID	integer	None.
BegDate	date	None.
EndDate	date	None.
GroupByCustomer	boolean	None.
GroupByItem	boolean	None.
GroupByClass	boolean	None.
GroupByRep	boolean	None.
SummaryView	boolean	None.
DetailView	boolean	None.
SLPRSNID	string	None.
ITMCLSCD	string	None.
ITEMNMBR	string	None.
CUSTNMBR	string	None.

Request Formats

application/json, text/json

Sample:

{
  "EmpID": 1,
  "BegDate": "2025-05-15T11:13:12.0068422+00:00",
  "EndDate": "2025-05-15T11:13:12.0068422+00:00",
  "GroupByCustomer": true,
  "GroupByItem": true,
  "GroupByClass": true,
  "GroupByRep": true,
  "SummaryView": true,
  "DetailView": true,
  "SLPRSNID": "sample string 10",
  "ITMCLSCD": "sample string 11",
  "ITEMNMBR": "sample string 12",
  "CUSTNMBR": "sample string 13"
}

application/xml, text/xml

Sample:

<SalesAnalysisCriteria xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/HCSAPI.DTOs">
  <BegDate>2025-05-15T11:13:12.0068422+00:00</BegDate>
  <CUSTNMBR>sample string 13</CUSTNMBR>
  <DetailView>true</DetailView>
  <EmpID>1</EmpID>
  <EndDate>2025-05-15T11:13:12.0068422+00:00</EndDate>
  <GroupByClass>true</GroupByClass>
  <GroupByCustomer>true</GroupByCustomer>
  <GroupByItem>true</GroupByItem>
  <GroupByRep>true</GroupByRep>
  <ITEMNMBR>sample string 12</ITEMNMBR>
  <ITMCLSCD>sample string 11</ITMCLSCD>
  <SLPRSNID>sample string 10</SLPRSNID>
  <SummaryView>true</SummaryView>
</SalesAnalysisCriteria>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Collection of SalesAnalysisDetail

Name	Type	Additional information
SOPNUMBE	string	None.
LineNumber	integer	None.
DocDate	date	None.
Partnership	string	None.
PartnershipCustNmbr	string	None.
CUSTNMBR	string	None.
CUSTNAME	string	None.
CustomerType	string	None.
RepID	string	None.
RepName	string	None.
RepCompany	string	None.
RepSegment	string	None.
RepGroup	string	None.
ShipToADDRESS1	string	None.
ShipToADDRESS2	string	None.
ShipToCity	string	None.
ShiptoState	string	None.
ShipZip	string	None.
Warehouse	string	None.
ItemNmbr	string	None.
ItemDesc	string	None.
ProductType	string	None.
Quantity	decimal number	None.
UofM	string	None.
BaseQty	decimal number	None.
BaseUofM	string	None.
UnitCost	decimal number	None.
ExtCost	decimal number	None.
UnitPrice	decimal number	None.
ExtPrice	decimal number	None.
Margin	decimal number	None.
GPSItemClass	string	None.
ScenarioItemClass	string	None.
GPSVendor	string	None.
ScenarioVendor	string	None.
MarginPercent	decimal number	None.
Criteria	string	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "SOPNUMBE": "sample string 1",
    "LineNumber": 2,
    "DocDate": "2025-05-15T11:13:12.0068422+00:00",
    "Partnership": "sample string 4",
    "PartnershipCustNmbr": "sample string 5",
    "CUSTNMBR": "sample string 6",
    "CUSTNAME": "sample string 7",
    "CustomerType": "sample string 8",
    "RepID": "sample string 9",
    "RepName": "sample string 10",
    "RepCompany": "sample string 11",
    "RepSegment": "sample string 12",
    "RepGroup": "sample string 13",
    "ShipToADDRESS1": "sample string 14",
    "ShipToADDRESS2": "sample string 15",
    "ShipToCity": "sample string 16",
    "ShiptoState": "sample string 17",
    "ShipZip": "sample string 18",
    "Warehouse": "sample string 19",
    "ItemNmbr": "sample string 20",
    "ItemDesc": "sample string 21",
    "ProductType": "sample string 22",
    "Quantity": 23.1,
    "UofM": "sample string 24",
    "BaseQty": 25.1,
    "BaseUofM": "sample string 26",
    "UnitCost": 27.1,
    "ExtCost": 28.1,
    "UnitPrice": 29.1,
    "ExtPrice": 30.1,
    "Margin": 31.1,
    "GPSItemClass": "sample string 32",
    "ScenarioItemClass": "sample string 33",
    "GPSVendor": "sample string 34",
    "ScenarioVendor": "sample string 35",
    "MarginPercent": 1.0332225913621262,
    "Criteria": "sample string 37"
  },
  {
    "SOPNUMBE": "sample string 1",
    "LineNumber": 2,
    "DocDate": "2025-05-15T11:13:12.0068422+00:00",
    "Partnership": "sample string 4",
    "PartnershipCustNmbr": "sample string 5",
    "CUSTNMBR": "sample string 6",
    "CUSTNAME": "sample string 7",
    "CustomerType": "sample string 8",
    "RepID": "sample string 9",
    "RepName": "sample string 10",
    "RepCompany": "sample string 11",
    "RepSegment": "sample string 12",
    "RepGroup": "sample string 13",
    "ShipToADDRESS1": "sample string 14",
    "ShipToADDRESS2": "sample string 15",
    "ShipToCity": "sample string 16",
    "ShiptoState": "sample string 17",
    "ShipZip": "sample string 18",
    "Warehouse": "sample string 19",
    "ItemNmbr": "sample string 20",
    "ItemDesc": "sample string 21",
    "ProductType": "sample string 22",
    "Quantity": 23.1,
    "UofM": "sample string 24",
    "BaseQty": 25.1,
    "BaseUofM": "sample string 26",
    "UnitCost": 27.1,
    "ExtCost": 28.1,
    "UnitPrice": 29.1,
    "ExtPrice": 30.1,
    "Margin": 31.1,
    "GPSItemClass": "sample string 32",
    "ScenarioItemClass": "sample string 33",
    "GPSVendor": "sample string 34",
    "ScenarioVendor": "sample string 35",
    "MarginPercent": 1.0332225913621262,
    "Criteria": "sample string 37"
  }
]

application/xml, text/xml

Sample:

<ArrayOfSalesAnalysisDetail xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/HCSAPI.DTOs">
  <SalesAnalysisDetail>
    <BaseQty>25.1</BaseQty>
    <BaseUofM>sample string 26</BaseUofM>
    <CUSTNAME>sample string 7</CUSTNAME>
    <CUSTNMBR>sample string 6</CUSTNMBR>
    <Criteria>sample string 37</Criteria>
    <CustomerType>sample string 8</CustomerType>
    <DocDate>2025-05-15T11:13:12.0068422+00:00</DocDate>
    <ExtCost>28.1</ExtCost>
    <ExtPrice>30.1</ExtPrice>
    <GPSItemClass>sample string 32</GPSItemClass>
    <GPSVendor>sample string 34</GPSVendor>
    <ItemDesc>sample string 21</ItemDesc>
    <ItemNmbr>sample string 20</ItemNmbr>
    <LineNumber>2</LineNumber>
    <Margin>31.1</Margin>
    <MarginPercent>1.0332225913621262</MarginPercent>
    <Partnership>sample string 4</Partnership>
    <PartnershipCustNmbr>sample string 5</PartnershipCustNmbr>
    <ProductType>sample string 22</ProductType>
    <Quantity>23.1</Quantity>
    <RepCompany>sample string 11</RepCompany>
    <RepGroup>sample string 13</RepGroup>
    <RepID>sample string 9</RepID>
    <RepName>sample string 10</RepName>
    <RepSegment>sample string 12</RepSegment>
    <SOPNUMBE>sample string 1</SOPNUMBE>
    <ScenarioItemClass>sample string 33</ScenarioItemClass>
    <ScenarioVendor>sample string 35</ScenarioVendor>
    <ShipToADDRESS1>sample string 14</ShipToADDRESS1>
    <ShipToADDRESS2>sample string 15</ShipToADDRESS2>
    <ShipToCity>sample string 16</ShipToCity>
    <ShipZip>sample string 18</ShipZip>
    <ShiptoState>sample string 17</ShiptoState>
    <UnitCost>27.1</UnitCost>
    <UnitPrice>29.1</UnitPrice>
    <UofM>sample string 24</UofM>
    <Warehouse>sample string 19</Warehouse>
  </SalesAnalysisDetail>
  <SalesAnalysisDetail>
    <BaseQty>25.1</BaseQty>
    <BaseUofM>sample string 26</BaseUofM>
    <CUSTNAME>sample string 7</CUSTNAME>
    <CUSTNMBR>sample string 6</CUSTNMBR>
    <Criteria>sample string 37</Criteria>
    <CustomerType>sample string 8</CustomerType>
    <DocDate>2025-05-15T11:13:12.0068422+00:00</DocDate>
    <ExtCost>28.1</ExtCost>
    <ExtPrice>30.1</ExtPrice>
    <GPSItemClass>sample string 32</GPSItemClass>
    <GPSVendor>sample string 34</GPSVendor>
    <ItemDesc>sample string 21</ItemDesc>
    <ItemNmbr>sample string 20</ItemNmbr>
    <LineNumber>2</LineNumber>
    <Margin>31.1</Margin>
    <MarginPercent>1.0332225913621262</MarginPercent>
    <Partnership>sample string 4</Partnership>
    <PartnershipCustNmbr>sample string 5</PartnershipCustNmbr>
    <ProductType>sample string 22</ProductType>
    <Quantity>23.1</Quantity>
    <RepCompany>sample string 11</RepCompany>
    <RepGroup>sample string 13</RepGroup>
    <RepID>sample string 9</RepID>
    <RepName>sample string 10</RepName>
    <RepSegment>sample string 12</RepSegment>
    <SOPNUMBE>sample string 1</SOPNUMBE>
    <ScenarioItemClass>sample string 33</ScenarioItemClass>
    <ScenarioVendor>sample string 35</ScenarioVendor>
    <ShipToADDRESS1>sample string 14</ShipToADDRESS1>
    <ShipToADDRESS2>sample string 15</ShipToADDRESS2>
    <ShipToCity>sample string 16</ShipToCity>
    <ShipZip>sample string 18</ShipZip>
    <ShiptoState>sample string 17</ShiptoState>
    <UnitCost>27.1</UnitCost>
    <UnitPrice>29.1</UnitPrice>
    <UofM>sample string 24</UofM>
    <Warehouse>sample string 19</Warehouse>
  </SalesAnalysisDetail>
</ArrayOfSalesAnalysisDetail>