POST api/HCS/GetSalesAnalysisSummary

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-15T12:44:49.8903141+00:00",
  "EndDate": "2025-05-15T12:44:49.8903141+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-15T12:44:49.8903141+00:00</BegDate>
  <CUSTNMBR>sample string 13</CUSTNMBR>
  <DetailView>true</DetailView>
  <EmpID>1</EmpID>
  <EndDate>2025-05-15T12:44:49.8903141+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 SalesAnalysisSummary

Name	Type	Additional information
Dimension1	string	None.
NumberNDescription	string	None.
Quantity	decimal number	None.
UofM	string	None.
Cost	decimal number	None.
Sales	decimal number	None.
Margin	decimal number	None.
Prior1Quantity	decimal number	None.
Prior1Sales	decimal number	None.
Prior1Cost	decimal number	None.
Prior1Margin	decimal number	None.
Prior2Quantity	decimal number	None.
Prior2Sales	decimal number	None.
Prior2Cost	decimal number	None.
Prior2Margin	decimal number	None.
MarginPercent	decimal number	None.
Prior1MarginPercent	decimal number	None.
Prior2MarginPercent	decimal number	None.
PriorsFilledIn	PriorsFilledIn	None.
SalesBudget	decimal number	None.
MarginBudget	decimal number	None.
MarginPercentBudget	decimal number	None.
SalesPercentBudget	decimal number	None.
SalesBudgVariance	decimal number	None.
MarginBudgVariance	decimal number	None.
SalesPrior1Variance	decimal number	None.
SalesPrior2Variance	decimal number	None.
MarginPrior1Variance	decimal number	None.
MarginPrior2Variance	decimal number	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "Dimension1": "sample string 1",
    "NumberNDescription": "sample string 2",
    "Quantity": 3.1,
    "UofM": "sample string 4",
    "Cost": 5.1,
    "Sales": 6.1,
    "Margin": 7.1,
    "Prior1Quantity": 1.1,
    "Prior1Sales": 1.1,
    "Prior1Cost": 1.1,
    "Prior1Margin": 1.1,
    "Prior2Quantity": 1.1,
    "Prior2Sales": 1.1,
    "Prior2Cost": 1.1,
    "Prior2Margin": 1.1,
    "MarginPercent": 116.4,
    "Prior1MarginPercent": 100.0,
    "Prior2MarginPercent": 100.0,
    "PriorsFilledIn": 0,
    "SalesBudget": 1.1,
    "MarginBudget": 1.1,
    "MarginPercentBudget": 6.4545454545454541,
    "SalesPercentBudget": 5.545454545454545,
    "SalesBudgVariance": 5.0,
    "MarginBudgVariance": 6.0,
    "SalesPrior1Variance": 5.0,
    "SalesPrior2Variance": 0.0,
    "MarginPrior1Variance": 6.0,
    "MarginPrior2Variance": 0.0
  },
  {
    "Dimension1": "sample string 1",
    "NumberNDescription": "sample string 2",
    "Quantity": 3.1,
    "UofM": "sample string 4",
    "Cost": 5.1,
    "Sales": 6.1,
    "Margin": 7.1,
    "Prior1Quantity": 1.1,
    "Prior1Sales": 1.1,
    "Prior1Cost": 1.1,
    "Prior1Margin": 1.1,
    "Prior2Quantity": 1.1,
    "Prior2Sales": 1.1,
    "Prior2Cost": 1.1,
    "Prior2Margin": 1.1,
    "MarginPercent": 116.4,
    "Prior1MarginPercent": 100.0,
    "Prior2MarginPercent": 100.0,
    "PriorsFilledIn": 0,
    "SalesBudget": 1.1,
    "MarginBudget": 1.1,
    "MarginPercentBudget": 6.4545454545454541,
    "SalesPercentBudget": 5.545454545454545,
    "SalesBudgVariance": 5.0,
    "MarginBudgVariance": 6.0,
    "SalesPrior1Variance": 5.0,
    "SalesPrior2Variance": 0.0,
    "MarginPrior1Variance": 6.0,
    "MarginPrior2Variance": 0.0
  }
]

application/xml, text/xml

Sample:

<ArrayOfSalesAnalysisSummary xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/HCSAPI.DTOs">
  <SalesAnalysisSummary>
    <Cost>5.1</Cost>
    <Dimension1>sample string 1</Dimension1>
    <Margin>7.1</Margin>
    <MarginBudgVariance>6</MarginBudgVariance>
    <MarginBudget>1.1</MarginBudget>
    <MarginPercent>116.4</MarginPercent>
    <MarginPercentBudget>6.4545454545454541</MarginPercentBudget>
    <MarginPrior1Variance>6</MarginPrior1Variance>
    <MarginPrior2Variance>0</MarginPrior2Variance>
    <NumberNDescription>sample string 2</NumberNDescription>
    <Prior1Cost>1.1</Prior1Cost>
    <Prior1Margin>1.1</Prior1Margin>
    <Prior1MarginPercent>100</Prior1MarginPercent>
    <Prior1Quantity>1.1</Prior1Quantity>
    <Prior1Sales>1.1</Prior1Sales>
    <Prior2Cost>1.1</Prior2Cost>
    <Prior2Margin>1.1</Prior2Margin>
    <Prior2MarginPercent>100</Prior2MarginPercent>
    <Prior2Quantity>1.1</Prior2Quantity>
    <Prior2Sales>1.1</Prior2Sales>
    <PriorsFilledIn>NoPriors</PriorsFilledIn>
    <Quantity>3.1</Quantity>
    <Sales>6.1</Sales>
    <SalesBudgVariance>5</SalesBudgVariance>
    <SalesBudget>1.1</SalesBudget>
    <SalesPercentBudget>5.545454545454545</SalesPercentBudget>
    <SalesPrior1Variance>5</SalesPrior1Variance>
    <SalesPrior2Variance>0</SalesPrior2Variance>
    <UofM>sample string 4</UofM>
  </SalesAnalysisSummary>
  <SalesAnalysisSummary>
    <Cost>5.1</Cost>
    <Dimension1>sample string 1</Dimension1>
    <Margin>7.1</Margin>
    <MarginBudgVariance>6</MarginBudgVariance>
    <MarginBudget>1.1</MarginBudget>
    <MarginPercent>116.4</MarginPercent>
    <MarginPercentBudget>6.4545454545454541</MarginPercentBudget>
    <MarginPrior1Variance>6</MarginPrior1Variance>
    <MarginPrior2Variance>0</MarginPrior2Variance>
    <NumberNDescription>sample string 2</NumberNDescription>
    <Prior1Cost>1.1</Prior1Cost>
    <Prior1Margin>1.1</Prior1Margin>
    <Prior1MarginPercent>100</Prior1MarginPercent>
    <Prior1Quantity>1.1</Prior1Quantity>
    <Prior1Sales>1.1</Prior1Sales>
    <Prior2Cost>1.1</Prior2Cost>
    <Prior2Margin>1.1</Prior2Margin>
    <Prior2MarginPercent>100</Prior2MarginPercent>
    <Prior2Quantity>1.1</Prior2Quantity>
    <Prior2Sales>1.1</Prior2Sales>
    <PriorsFilledIn>NoPriors</PriorsFilledIn>
    <Quantity>3.1</Quantity>
    <Sales>6.1</Sales>
    <SalesBudgVariance>5</SalesBudgVariance>
    <SalesBudget>1.1</SalesBudget>
    <SalesPercentBudget>5.545454545454545</SalesPercentBudget>
    <SalesPrior1Variance>5</SalesPrior1Variance>
    <SalesPrior2Variance>0</SalesPrior2Variance>
    <UofM>sample string 4</UofM>
  </SalesAnalysisSummary>
</ArrayOfSalesAnalysisSummary>