POST api/budget/GetExpenseInquiry
Request Information
URI Parameters
None.
Body Parameters
BudgetCriteria| Name | Description | Type | Additional information |
|---|---|---|---|
| username | string |
None. |
|
| BudgetYear | string |
None. |
|
| BudgetGroups | Collection of string |
None. |
|
| Reps | Collection of string |
None. |
|
| IncludeInactiveAccounts | boolean |
None. |
|
| BlendedFert | boolean |
None. |
|
| Polyon | boolean |
None. |
|
| AllOtherClasses | boolean |
None. |
|
| SalesBudget | boolean |
None. |
|
| MarginBudget | boolean |
None. |
|
| COGSBudget | boolean |
None. |
|
| GLAcctNmbr | string |
None. |
|
| SLPRSNID | string |
None. |
|
| BudgetID | string |
None. |
|
| DetailView | boolean |
None. |
|
| MonthName | string |
None. |
Request Formats
application/json, text/json
Sample:
{
"username": "sample string 1",
"BudgetYear": "sample string 2",
"BudgetGroups": [
"sample string 1",
"sample string 2"
],
"Reps": [
"sample string 1",
"sample string 2"
],
"IncludeInactiveAccounts": true,
"BlendedFert": true,
"Polyon": true,
"AllOtherClasses": true,
"SalesBudget": true,
"MarginBudget": true,
"COGSBudget": true,
"GLAcctNmbr": "sample string 10",
"SLPRSNID": "sample string 11",
"BudgetID": "sample string 12",
"DetailView": true,
"MonthName": "sample string 14"
}
application/xml, text/xml
Sample:
<BudgetCriteria xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GoHarrellsAPI.Models">
<AllOtherClasses>true</AllOtherClasses>
<BlendedFert>true</BlendedFert>
<BudgetGroups xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>sample string 1</d2p1:string>
<d2p1:string>sample string 2</d2p1:string>
</BudgetGroups>
<BudgetID>sample string 12</BudgetID>
<BudgetYear>sample string 2</BudgetYear>
<COGSBudget>true</COGSBudget>
<DetailView>true</DetailView>
<GLAcctNmbr>sample string 10</GLAcctNmbr>
<IncludeInactiveAccounts>true</IncludeInactiveAccounts>
<MarginBudget>true</MarginBudget>
<MonthName>sample string 14</MonthName>
<Polyon>true</Polyon>
<Reps xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>sample string 1</d2p1:string>
<d2p1:string>sample string 2</d2p1:string>
</Reps>
<SLPRSNID>sample string 11</SLPRSNID>
<SalesBudget>true</SalesBudget>
<username>sample string 1</username>
</BudgetCriteria>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
Collection of BudgetInquiry| Name | Description | Type | Additional information |
|---|---|---|---|
| RepID | string |
None. |
|
| RepName | string |
None. |
|
| InquiryType | string |
None. |
|
| SortNmbr | integer |
None. |
|
| RecType | string |
None. |
|
| ProdClass | string |
None. |
|
| ToolTip | string |
None. |
|
| AcctType | string |
None. |
|
| AcctNmbr | string |
None. |
|
| AcctDesc | string |
None. |
|
| PriorPer | decimal number |
None. |
|
| CurrPer | decimal number |
None. |
|
| BudgPer | decimal number |
None. |
|
| DisplayComments | string |
None. |
|
| ExcelComments | string |
None. |
|
| PerVarPrior | decimal number |
None. |
|
| PerVarBudg | decimal number |
None. |
|
| PriorYTD | decimal number |
None. |
|
| CurrYTD | decimal number |
None. |
|
| BudgYTD | decimal number |
None. |
|
| YTDVarPrior | decimal number |
None. |
|
| YTDVarBudg | decimal number |
None. |
|
| AnnualBudg | decimal number |
None. |
|
| BudgetRemain | decimal number |
None. |
|
| CurrPerBackgroundRed | boolean |
None. |
|
| PerVarBudgFontRed | boolean |
None. |
|
| CurrYTDBackgroundRed | boolean |
None. |
|
| YTDVarBudgFontRed | boolean |
None. |
|
| BudgRemFontRed | boolean |
None. |
Response Formats
application/json, text/json
Sample:
[
{
"RepID": "sample string 1",
"RepName": "sample string 2",
"InquiryType": "sample string 3",
"SortNmbr": 4,
"RecType": "sample string 5",
"ProdClass": "sample string 6",
"ToolTip": "sample string 7",
"AcctType": "sample string 8",
"AcctNmbr": "sample string 9",
"AcctDesc": "sample string 10",
"PriorPer": 11.0,
"CurrPer": 12.0,
"BudgPer": 13.0,
"DisplayComments": "sample string 14",
"ExcelComments": "sample string 15",
"PerVarPrior": 1.0,
"PerVarBudg": -1.0,
"PriorYTD": 18.0,
"CurrYTD": 19.0,
"BudgYTD": 20.0,
"YTDVarPrior": 1.0,
"YTDVarBudg": -1.0,
"AnnualBudg": 23.0,
"BudgetRemain": 4.0,
"CurrPerBackgroundRed": false,
"PerVarBudgFontRed": false,
"CurrYTDBackgroundRed": false,
"YTDVarBudgFontRed": false,
"BudgRemFontRed": false
},
{
"RepID": "sample string 1",
"RepName": "sample string 2",
"InquiryType": "sample string 3",
"SortNmbr": 4,
"RecType": "sample string 5",
"ProdClass": "sample string 6",
"ToolTip": "sample string 7",
"AcctType": "sample string 8",
"AcctNmbr": "sample string 9",
"AcctDesc": "sample string 10",
"PriorPer": 11.0,
"CurrPer": 12.0,
"BudgPer": 13.0,
"DisplayComments": "sample string 14",
"ExcelComments": "sample string 15",
"PerVarPrior": 1.0,
"PerVarBudg": -1.0,
"PriorYTD": 18.0,
"CurrYTD": 19.0,
"BudgYTD": 20.0,
"YTDVarPrior": 1.0,
"YTDVarBudg": -1.0,
"AnnualBudg": 23.0,
"BudgetRemain": 4.0,
"CurrPerBackgroundRed": false,
"PerVarBudgFontRed": false,
"CurrYTDBackgroundRed": false,
"YTDVarBudgFontRed": false,
"BudgRemFontRed": false
}
]
application/xml, text/xml
Sample:
<ArrayOfBudgetInquiry xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GoHarrellsAPI.Models">
<BudgetInquiry>
<AcctDesc>sample string 10</AcctDesc>
<AcctNmbr>sample string 9</AcctNmbr>
<AcctType>sample string 8</AcctType>
<AnnualBudg>23</AnnualBudg>
<BudgPer>13</BudgPer>
<BudgRemFontRed>false</BudgRemFontRed>
<BudgYTD>20</BudgYTD>
<BudgetRemain>4</BudgetRemain>
<CurrPer>12</CurrPer>
<CurrPerBackgroundRed>false</CurrPerBackgroundRed>
<CurrYTD>19</CurrYTD>
<CurrYTDBackgroundRed>false</CurrYTDBackgroundRed>
<DisplayComments>sample string 14</DisplayComments>
<ExcelComments>sample string 15</ExcelComments>
<InquiryType>sample string 3</InquiryType>
<PerVarBudg>-1</PerVarBudg>
<PerVarBudgFontRed>false</PerVarBudgFontRed>
<PerVarPrior>1</PerVarPrior>
<PriorPer>11</PriorPer>
<PriorYTD>18</PriorYTD>
<ProdClass>sample string 6</ProdClass>
<RecType>sample string 5</RecType>
<RepID>sample string 1</RepID>
<RepName>sample string 2</RepName>
<SortNmbr>4</SortNmbr>
<ToolTip>sample string 7</ToolTip>
<YTDVarBudg>-1</YTDVarBudg>
<YTDVarBudgFontRed>false</YTDVarBudgFontRed>
<YTDVarPrior>1</YTDVarPrior>
</BudgetInquiry>
<BudgetInquiry>
<AcctDesc>sample string 10</AcctDesc>
<AcctNmbr>sample string 9</AcctNmbr>
<AcctType>sample string 8</AcctType>
<AnnualBudg>23</AnnualBudg>
<BudgPer>13</BudgPer>
<BudgRemFontRed>false</BudgRemFontRed>
<BudgYTD>20</BudgYTD>
<BudgetRemain>4</BudgetRemain>
<CurrPer>12</CurrPer>
<CurrPerBackgroundRed>false</CurrPerBackgroundRed>
<CurrYTD>19</CurrYTD>
<CurrYTDBackgroundRed>false</CurrYTDBackgroundRed>
<DisplayComments>sample string 14</DisplayComments>
<ExcelComments>sample string 15</ExcelComments>
<InquiryType>sample string 3</InquiryType>
<PerVarBudg>-1</PerVarBudg>
<PerVarBudgFontRed>false</PerVarBudgFontRed>
<PerVarPrior>1</PerVarPrior>
<PriorPer>11</PriorPer>
<PriorYTD>18</PriorYTD>
<ProdClass>sample string 6</ProdClass>
<RecType>sample string 5</RecType>
<RepID>sample string 1</RepID>
<RepName>sample string 2</RepName>
<SortNmbr>4</SortNmbr>
<ToolTip>sample string 7</ToolTip>
<YTDVarBudg>-1</YTDVarBudg>
<YTDVarBudgFontRed>false</YTDVarBudgFontRed>
<YTDVarPrior>1</YTDVarPrior>
</BudgetInquiry>
</ArrayOfBudgetInquiry>