POST api/salesanalysistool/getSATDetail
Request Information
URI Parameters
None.
Body Parameters
SATCriteria| Name | Description | Type | Additional information |
|---|---|---|---|
| LOCNCODE | string |
None. |
|
| Segment | string |
None. |
|
| ReportGroup | string |
None. |
|
| RepID | string |
None. |
|
| Partnership | string |
None. |
|
| Customer | string |
None. |
|
| Category | string |
None. |
|
| Item | string |
None. |
|
| Class | string |
None. |
|
| Vendor | string |
None. |
|
| Type | string |
None. |
|
| ExcludeZZs | boolean |
None. |
|
| BeginDate | date |
None. |
|
| EndDate | date |
None. |
|
| GroupByField | string |
None. |
|
| SearchFor | string |
None. |
|
| PagingStart | integer |
None. |
|
| NumRecs | integer |
None. |
|
| SortFieldName | string |
None. |
|
| SortDirection | string |
None. |
|
| UserName | string |
None. |
|
| SATView | string |
None. |
Request Formats
application/json, text/json
Sample:
{
"LOCNCODE": "sample string 1",
"Segment": "sample string 2",
"ReportGroup": "sample string 3",
"RepID": "sample string 4",
"Partnership": "sample string 5",
"Customer": "sample string 6",
"Category": "sample string 7",
"Item": "sample string 8",
"Class": "sample string 9",
"Vendor": "sample string 10",
"Type": "sample string 11",
"ExcludeZZs": true,
"BeginDate": "2026-11-21T14:48:58.8211224+00:00",
"EndDate": "2026-11-21T14:48:58.8211224+00:00",
"GroupByField": "sample string 15",
"SearchFor": "sample string 16",
"PagingStart": 1,
"NumRecs": 1,
"SortFieldName": "sample string 17",
"SortDirection": "sample string 18",
"UserName": "sample string 19",
"SATView": "sample string 20"
}
application/xml, text/xml
Sample:
<SATCriteria xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GoHarrellsAPI.Models"> <BeginDate>2026-11-21T14:48:58.8211224+00:00</BeginDate> <Category>sample string 7</Category> <Class>sample string 9</Class> <Customer>sample string 6</Customer> <EndDate>2026-11-21T14:48:58.8211224+00:00</EndDate> <ExcludeZZs>true</ExcludeZZs> <GroupByField>sample string 15</GroupByField> <Item>sample string 8</Item> <LOCNCODE>sample string 1</LOCNCODE> <NumRecs>1</NumRecs> <PagingStart>1</PagingStart> <Partnership>sample string 5</Partnership> <RepID>sample string 4</RepID> <ReportGroup>sample string 3</ReportGroup> <SATView>sample string 20</SATView> <SearchFor>sample string 16</SearchFor> <Segment>sample string 2</Segment> <SortDirection>sample string 18</SortDirection> <SortFieldName>sample string 17</SortFieldName> <Type>sample string 11</Type> <UserName>sample string 19</UserName> <Vendor>sample string 10</Vendor> </SATCriteria>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
Collection of SalesAnalysisDetail| Name | Description | Type | Additional information |
|---|---|---|---|
| CUSTNMBR | string |
None. |
|
| CUSTNAME | string |
None. |
|
| SOPNUMBE | string |
None. |
|
| DOCDATE | date |
None. |
|
| ITEMNMBR | string |
None. |
|
| ITEMDESC | string |
None. |
|
| QUANTITY | decimal number |
None. |
|
| UOFM | string |
None. |
|
| UNITCOST | decimal number |
None. |
|
| UNITPRICE | decimal number |
None. |
|
| EXTPRICE | decimal number |
None. |
|
| EXTCOST | decimal number |
None. |
|
| MARGDOLLARS | decimal number |
None. |
|
| MARGPERC | decimal number |
None. |
|
| ITEMCLASS | string |
None. |
|
| REPID | string |
None. |
|
| REPNAME | string |
None. |
|
| REPGROUP | string |
None. |
|
| VENDOR | string |
None. |
|
| Segment | string |
None. |
Response Formats
application/json, text/json
Sample:
[
{
"CUSTNMBR": "sample string 1",
"CUSTNAME": "sample string 2",
"SOPNUMBE": "sample string 3",
"DOCDATE": "2026-11-21T14:48:58.8211224+00:00",
"ITEMNMBR": "sample string 5",
"ITEMDESC": "sample string 6",
"QUANTITY": 7.1,
"UOFM": "sample string 8",
"UNITCOST": 9.1,
"UNITPRICE": 10.1,
"EXTPRICE": 11.1,
"EXTCOST": 12.1,
"MARGDOLLARS": 13.1,
"MARGPERC": 14.1,
"ITEMCLASS": "sample string 15",
"REPID": "sample string 16",
"REPNAME": "sample string 17",
"REPGROUP": "sample string 18",
"VENDOR": "sample string 19",
"Segment": "sample string 20"
},
{
"CUSTNMBR": "sample string 1",
"CUSTNAME": "sample string 2",
"SOPNUMBE": "sample string 3",
"DOCDATE": "2026-11-21T14:48:58.8211224+00:00",
"ITEMNMBR": "sample string 5",
"ITEMDESC": "sample string 6",
"QUANTITY": 7.1,
"UOFM": "sample string 8",
"UNITCOST": 9.1,
"UNITPRICE": 10.1,
"EXTPRICE": 11.1,
"EXTCOST": 12.1,
"MARGDOLLARS": 13.1,
"MARGPERC": 14.1,
"ITEMCLASS": "sample string 15",
"REPID": "sample string 16",
"REPNAME": "sample string 17",
"REPGROUP": "sample string 18",
"VENDOR": "sample string 19",
"Segment": "sample string 20"
}
]
application/xml, text/xml
Sample:
<ArrayOfSalesAnalysisDetail xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GoHarrellsAPI.Models">
<SalesAnalysisDetail>
<CUSTNAME>sample string 2</CUSTNAME>
<CUSTNMBR>sample string 1</CUSTNMBR>
<DOCDATE>2026-11-21T14:48:58.8211224+00:00</DOCDATE>
<EXTCOST>12.1</EXTCOST>
<EXTPRICE>11.1</EXTPRICE>
<ITEMCLASS>sample string 15</ITEMCLASS>
<ITEMDESC>sample string 6</ITEMDESC>
<ITEMNMBR>sample string 5</ITEMNMBR>
<MARGDOLLARS>13.1</MARGDOLLARS>
<MARGPERC>14.1</MARGPERC>
<QUANTITY>7.1</QUANTITY>
<REPGROUP>sample string 18</REPGROUP>
<REPID>sample string 16</REPID>
<REPNAME>sample string 17</REPNAME>
<SOPNUMBE>sample string 3</SOPNUMBE>
<Segment>sample string 20</Segment>
<UNITCOST>9.1</UNITCOST>
<UNITPRICE>10.1</UNITPRICE>
<UOFM>sample string 8</UOFM>
<VENDOR>sample string 19</VENDOR>
</SalesAnalysisDetail>
<SalesAnalysisDetail>
<CUSTNAME>sample string 2</CUSTNAME>
<CUSTNMBR>sample string 1</CUSTNMBR>
<DOCDATE>2026-11-21T14:48:58.8211224+00:00</DOCDATE>
<EXTCOST>12.1</EXTCOST>
<EXTPRICE>11.1</EXTPRICE>
<ITEMCLASS>sample string 15</ITEMCLASS>
<ITEMDESC>sample string 6</ITEMDESC>
<ITEMNMBR>sample string 5</ITEMNMBR>
<MARGDOLLARS>13.1</MARGDOLLARS>
<MARGPERC>14.1</MARGPERC>
<QUANTITY>7.1</QUANTITY>
<REPGROUP>sample string 18</REPGROUP>
<REPID>sample string 16</REPID>
<REPNAME>sample string 17</REPNAME>
<SOPNUMBE>sample string 3</SOPNUMBE>
<Segment>sample string 20</Segment>
<UNITCOST>9.1</UNITCOST>
<UNITPRICE>10.1</UNITPRICE>
<UOFM>sample string 8</UOFM>
<VENDOR>sample string 19</VENDOR>
</SalesAnalysisDetail>
</ArrayOfSalesAnalysisDetail>