POST api/salesanalysistool/getSATBudgetData
Request Information
URI Parameters
None.
Body Parameters
SATBudgetCriteria| Name | Description | Type | Additional information |
|---|---|---|---|
| GroupBy | string |
None. |
|
| BegDate | date |
None. |
|
| EndDate | date |
None. |
|
| Prior1BegDate | date |
None. |
|
| Prior1EndDate | date |
None. |
|
| BegYear | integer |
None. |
|
| EndYear | integer |
None. |
|
| BegMonth | integer |
None. |
|
| EndMonth | integer |
None. |
|
| SearchSalesRep | string |
None. |
|
| SearchRepSegment | string |
None. |
|
| SearchRepGroup | string |
None. |
|
| SearchClass | string |
None. |
Request Formats
application/json, text/json
Sample:
{
"GroupBy": "sample string 1",
"BegDate": "2026-11-21T14:53:02.5615244+00:00",
"EndDate": "2026-11-21T14:53:02.5615244+00:00",
"Prior1BegDate": "2026-11-21T14:53:02.5615244+00:00",
"Prior1EndDate": "2026-11-21T14:53:02.5615244+00:00",
"BegYear": 6,
"EndYear": 7,
"BegMonth": 8,
"EndMonth": 9,
"SearchSalesRep": "sample string 10",
"SearchRepSegment": "sample string 11",
"SearchRepGroup": "sample string 12",
"SearchClass": "sample string 13"
}
application/xml, text/xml
Sample:
<SATBudgetCriteria xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GoHarrellsAPI.Models"> <BegDate>2026-11-21T14:53:02.5615244+00:00</BegDate> <BegMonth>8</BegMonth> <BegYear>6</BegYear> <EndDate>2026-11-21T14:53:02.5615244+00:00</EndDate> <EndMonth>9</EndMonth> <EndYear>7</EndYear> <GroupBy>sample string 1</GroupBy> <Prior1BegDate>2026-11-21T14:53:02.5615244+00:00</Prior1BegDate> <Prior1EndDate>2026-11-21T14:53:02.5615244+00:00</Prior1EndDate> <SearchClass>sample string 13</SearchClass> <SearchRepGroup>sample string 12</SearchRepGroup> <SearchRepSegment>sample string 11</SearchRepSegment> <SearchSalesRep>sample string 10</SearchSalesRep> </SATBudgetCriteria>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
Collection of SATBudgetRow| Name | Description | Type | Additional information |
|---|---|---|---|
| Dimension1 | string |
None. |
|
| Sales | decimal number |
None. |
|
| Cost | decimal number |
None. |
|
| Margin | decimal number |
None. |
|
| SalesBudget | decimal number |
None. |
|
| MarginBudget | decimal number |
None. |
|
| Prior1Sales | decimal number |
None. |
|
| Prior1Cost | decimal number |
None. |
|
| Prior1Margin | decimal number |
None. |
|
| MarginPct | decimal number |
None. |
|
| SalesPctBudget | decimal number |
None. |
|
| SalesBudgVariance | decimal number |
None. |
|
| MarginBudgVariance | decimal number |
None. |
|
| SalesPrior1Variance | decimal number |
None. |
|
| MarginPrior1Variance | decimal number |
None. |
Response Formats
application/json, text/json
Sample:
[
{
"Dimension1": "sample string 1",
"Sales": 2.0,
"Cost": 3.0,
"Margin": 4.0,
"SalesBudget": 5.0,
"MarginBudget": 6.0,
"Prior1Sales": 7.0,
"Prior1Cost": 8.0,
"Prior1Margin": 9.0,
"MarginPct": 10.0,
"SalesPctBudget": 11.0,
"SalesBudgVariance": 12.0,
"MarginBudgVariance": 13.0,
"SalesPrior1Variance": 14.0,
"MarginPrior1Variance": 15.0
},
{
"Dimension1": "sample string 1",
"Sales": 2.0,
"Cost": 3.0,
"Margin": 4.0,
"SalesBudget": 5.0,
"MarginBudget": 6.0,
"Prior1Sales": 7.0,
"Prior1Cost": 8.0,
"Prior1Margin": 9.0,
"MarginPct": 10.0,
"SalesPctBudget": 11.0,
"SalesBudgVariance": 12.0,
"MarginBudgVariance": 13.0,
"SalesPrior1Variance": 14.0,
"MarginPrior1Variance": 15.0
}
]
application/xml, text/xml
Sample:
<ArrayOfSATBudgetRow xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GoHarrellsAPI.Models">
<SATBudgetRow>
<Cost>3</Cost>
<Dimension1>sample string 1</Dimension1>
<Margin>4</Margin>
<MarginBudgVariance>13</MarginBudgVariance>
<MarginBudget>6</MarginBudget>
<MarginPct>10</MarginPct>
<MarginPrior1Variance>15</MarginPrior1Variance>
<Prior1Cost>8</Prior1Cost>
<Prior1Margin>9</Prior1Margin>
<Prior1Sales>7</Prior1Sales>
<Sales>2</Sales>
<SalesBudgVariance>12</SalesBudgVariance>
<SalesBudget>5</SalesBudget>
<SalesPctBudget>11</SalesPctBudget>
<SalesPrior1Variance>14</SalesPrior1Variance>
</SATBudgetRow>
<SATBudgetRow>
<Cost>3</Cost>
<Dimension1>sample string 1</Dimension1>
<Margin>4</Margin>
<MarginBudgVariance>13</MarginBudgVariance>
<MarginBudget>6</MarginBudget>
<MarginPct>10</MarginPct>
<MarginPrior1Variance>15</MarginPrior1Variance>
<Prior1Cost>8</Prior1Cost>
<Prior1Margin>9</Prior1Margin>
<Prior1Sales>7</Prior1Sales>
<Sales>2</Sales>
<SalesBudgVariance>12</SalesBudgVariance>
<SalesBudget>5</SalesBudget>
<SalesPctBudget>11</SalesPctBudget>
<SalesPrior1Variance>14</SalesPrior1Variance>
</SATBudgetRow>
</ArrayOfSATBudgetRow>