POST api/{programid}/Budget/GetBudgetDetails

Request Information

URI Parameters

NameDescriptionTypeAdditional information
programid

string

Required

Body Parameters

ConsumerBudget
NameDescriptionTypeAdditional information
ConsumerBudgetNo

string

None.
ConsumerBudgetStartDate

string

None.
ConsumerBudgetEndDate

string

None.
ConsumerBudgetAmount

string

None.
ConsumerProgramCode

string

None.
ConsumerPANo

string

None.
ConsumerBudgetID

string

None.
ConsumerBudgetType

string

None.
ConsumerBudgetAplliedToID

string

None.
WaiverType

string

None.
ConsumerBudgetStatus

string

None.
CreatedBy

string

None.
CreatedDateAndTime

string

None.
ConsumerBudgetLineNo

string

None.
ModifiedBy

string

None.
ModifiedDateAndTime

string

None.
InitialBudgetAmount

string

None.
Comment

string

None.
ServiceGroupCode

string

None.
DisAllowTimesheet

string

None.
DisAllowInvoice

string

None.
BudgetLabel

string

None.
LineAction

string

None.
SweepAmount

string

None.
AuthApprovedAmount

string

None.
AuthRecoupAmount

string

None.
AuthExceptionDeniedAmount

string

None.
AuthGoodToPayUnits

string

None.
AuthGoodToPayDollars

string

None.
AuthPaidUnits

string

None.
AuthPaidDollars

string

None.
AuthQty

string

None.
AuthTargetAmount

string

None.
AuthAmtSavedGoodToPayDollars

string

None.
AuthAmtSavedPaidDollars

string

None.
AuthSweepAmount

string

None.
SweepToBudgetLable1Amount

string

None.
SweepToBudgetLable2Amount

string

None.
SweepToBudgetLable3Amount

string

None.
BudgetAuthLineCount

string

None.
DimCode1

string

None.
DimCode2

string

None.

Request Formats

application/json, text/json

Sample: 
{
  "ConsumerBudgetNo": "sample string 1",
  "ConsumerBudgetStartDate": "sample string 2",
  "ConsumerBudgetEndDate": "sample string 3",
  "ConsumerBudgetAmount": "sample string 4",
  "ConsumerProgramCode": "sample string 5",
  "ConsumerPANo": "sample string 6",
  "ConsumerBudgetID": "sample string 7",
  "ConsumerBudgetType": "sample string 8",
  "ConsumerBudgetAplliedToID": "sample string 9",
  "WaiverType": "sample string 10",
  "ConsumerBudgetStatus": "sample string 11",
  "CreatedBy": "sample string 12",
  "CreatedDateAndTime": "sample string 13",
  "ConsumerBudgetLineNo": "sample string 14",
  "ModifiedBy": "sample string 15",
  "ModifiedDateAndTime": "sample string 16",
  "InitialBudgetAmount": "sample string 17",
  "Comment": "sample string 18",
  "ServiceGroupCode": "sample string 19",
  "DisAllowTimesheet": "sample string 20",
  "DisAllowInvoice": "sample string 21",
  "BudgetLabel": "sample string 22",
  "LineAction": "sample string 23",
  "SweepAmount": "sample string 24",
  "AuthApprovedAmount": "sample string 25",
  "AuthRecoupAmount": "sample string 26",
  "AuthExceptionDeniedAmount": "sample string 27",
  "AuthGoodToPayUnits": "sample string 28",
  "AuthGoodToPayDollars": "sample string 29",
  "AuthPaidUnits": "sample string 30",
  "AuthPaidDollars": "sample string 31",
  "AuthQty": "sample string 32",
  "AuthTargetAmount": "sample string 33",
  "AuthAmtSavedGoodToPayDollars": "sample string 34",
  "AuthAmtSavedPaidDollars": "sample string 35",
  "AuthSweepAmount": "sample string 36",
  "SweepToBudgetLable1Amount": "sample string 37",
  "SweepToBudgetLable2Amount": "sample string 38",
  "SweepToBudgetLable3Amount": "sample string 39",
  "BudgetAuthLineCount": "sample string 40",
  "DimCode1": "sample string 41",
  "DimCode2": "sample string 42"
}

application/xml, text/xml

Sample: 
<ConsumerBudget xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PPL.Services.Models.NavisionData.CommonClasses.Budget">
  <AuthAmtSavedGoodToPayDollars>sample string 34</AuthAmtSavedGoodToPayDollars>
  <AuthAmtSavedPaidDollars>sample string 35</AuthAmtSavedPaidDollars>
  <AuthApprovedAmount>sample string 25</AuthApprovedAmount>
  <AuthExceptionDeniedAmount>sample string 27</AuthExceptionDeniedAmount>
  <AuthGoodToPayDollars>sample string 29</AuthGoodToPayDollars>
  <AuthGoodToPayUnits>sample string 28</AuthGoodToPayUnits>
  <AuthPaidDollars>sample string 31</AuthPaidDollars>
  <AuthPaidUnits>sample string 30</AuthPaidUnits>
  <AuthQty>sample string 32</AuthQty>
  <AuthRecoupAmount>sample string 26</AuthRecoupAmount>
  <AuthSweepAmount>sample string 36</AuthSweepAmount>
  <AuthTargetAmount>sample string 33</AuthTargetAmount>
  <BudgetAuthLineCount>sample string 40</BudgetAuthLineCount>
  <BudgetLabel>sample string 22</BudgetLabel>
  <Comment>sample string 18</Comment>
  <ConsumerBudgetAmount>sample string 4</ConsumerBudgetAmount>
  <ConsumerBudgetAplliedToID>sample string 9</ConsumerBudgetAplliedToID>
  <ConsumerBudgetEndDate>sample string 3</ConsumerBudgetEndDate>
  <ConsumerBudgetID>sample string 7</ConsumerBudgetID>
  <ConsumerBudgetLineNo>sample string 14</ConsumerBudgetLineNo>
  <ConsumerBudgetNo>sample string 1</ConsumerBudgetNo>
  <ConsumerBudgetStartDate>sample string 2</ConsumerBudgetStartDate>
  <ConsumerBudgetStatus>sample string 11</ConsumerBudgetStatus>
  <ConsumerBudgetType>sample string 8</ConsumerBudgetType>
  <ConsumerPANo>sample string 6</ConsumerPANo>
  <ConsumerProgramCode>sample string 5</ConsumerProgramCode>
  <CreatedBy>sample string 12</CreatedBy>
  <CreatedDateAndTime>sample string 13</CreatedDateAndTime>
  <DimCode1>sample string 41</DimCode1>
  <DimCode2>sample string 42</DimCode2>
  <DisAllowInvoice>sample string 21</DisAllowInvoice>
  <DisAllowTimesheet>sample string 20</DisAllowTimesheet>
  <InitialBudgetAmount>sample string 17</InitialBudgetAmount>
  <LineAction>sample string 23</LineAction>
  <ModifiedBy>sample string 15</ModifiedBy>
  <ModifiedDateAndTime>sample string 16</ModifiedDateAndTime>
  <ServiceGroupCode>sample string 19</ServiceGroupCode>
  <SweepAmount>sample string 24</SweepAmount>
  <SweepToBudgetLable1Amount>sample string 37</SweepToBudgetLable1Amount>
  <SweepToBudgetLable2Amount>sample string 38</SweepToBudgetLable2Amount>
  <SweepToBudgetLable3Amount>sample string 39</SweepToBudgetLable3Amount>
  <WaiverType>sample string 10</WaiverType>
</ConsumerBudget>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'ConsumerBudget'.

Response Information

Resource Description

ConsumerBudget
NameDescriptionTypeAdditional information
ConsumerBudgetNo

string

None.
ConsumerBudgetStartDate

string

None.
ConsumerBudgetEndDate

string

None.
ConsumerBudgetAmount

string

None.
ConsumerProgramCode

string

None.
ConsumerPANo

string

None.
ConsumerBudgetID

string

None.
ConsumerBudgetType

string

None.
ConsumerBudgetAplliedToID

string

None.
WaiverType

string

None.
ConsumerBudgetStatus

string

None.
CreatedBy

string

None.
CreatedDateAndTime

string

None.
ConsumerBudgetLineNo

string

None.
ModifiedBy

string

None.
ModifiedDateAndTime

string

None.
InitialBudgetAmount

string

None.
Comment

string

None.
ServiceGroupCode

string

None.
DisAllowTimesheet

string

None.
DisAllowInvoice

string

None.
BudgetLabel

string

None.
LineAction

string

None.
SweepAmount

string

None.
AuthApprovedAmount

string

None.
AuthRecoupAmount

string

None.
AuthExceptionDeniedAmount

string

None.
AuthGoodToPayUnits

string

None.
AuthGoodToPayDollars

string

None.
AuthPaidUnits

string

None.
AuthPaidDollars

string

None.
AuthQty

string

None.
AuthTargetAmount

string

None.
AuthAmtSavedGoodToPayDollars

string

None.
AuthAmtSavedPaidDollars

string

None.
AuthSweepAmount

string

None.
SweepToBudgetLable1Amount

string

None.
SweepToBudgetLable2Amount

string

None.
SweepToBudgetLable3Amount

string

None.
BudgetAuthLineCount

string

None.
DimCode1

string

None.
DimCode2

string

None.

Response Formats

application/json, text/json

Sample: 
{
  "ConsumerBudgetNo": "sample string 1",
  "ConsumerBudgetStartDate": "sample string 2",
  "ConsumerBudgetEndDate": "sample string 3",
  "ConsumerBudgetAmount": "sample string 4",
  "ConsumerProgramCode": "sample string 5",
  "ConsumerPANo": "sample string 6",
  "ConsumerBudgetID": "sample string 7",
  "ConsumerBudgetType": "sample string 8",
  "ConsumerBudgetAplliedToID": "sample string 9",
  "WaiverType": "sample string 10",
  "ConsumerBudgetStatus": "sample string 11",
  "CreatedBy": "sample string 12",
  "CreatedDateAndTime": "sample string 13",
  "ConsumerBudgetLineNo": "sample string 14",
  "ModifiedBy": "sample string 15",
  "ModifiedDateAndTime": "sample string 16",
  "InitialBudgetAmount": "sample string 17",
  "Comment": "sample string 18",
  "ServiceGroupCode": "sample string 19",
  "DisAllowTimesheet": "sample string 20",
  "DisAllowInvoice": "sample string 21",
  "BudgetLabel": "sample string 22",
  "LineAction": "sample string 23",
  "SweepAmount": "sample string 24",
  "AuthApprovedAmount": "sample string 25",
  "AuthRecoupAmount": "sample string 26",
  "AuthExceptionDeniedAmount": "sample string 27",
  "AuthGoodToPayUnits": "sample string 28",
  "AuthGoodToPayDollars": "sample string 29",
  "AuthPaidUnits": "sample string 30",
  "AuthPaidDollars": "sample string 31",
  "AuthQty": "sample string 32",
  "AuthTargetAmount": "sample string 33",
  "AuthAmtSavedGoodToPayDollars": "sample string 34",
  "AuthAmtSavedPaidDollars": "sample string 35",
  "AuthSweepAmount": "sample string 36",
  "SweepToBudgetLable1Amount": "sample string 37",
  "SweepToBudgetLable2Amount": "sample string 38",
  "SweepToBudgetLable3Amount": "sample string 39",
  "BudgetAuthLineCount": "sample string 40",
  "DimCode1": "sample string 41",
  "DimCode2": "sample string 42"
}

application/xml, text/xml

Sample: 
<ConsumerBudget xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PPL.Services.Models.NavisionData.CommonClasses.Budget">
  <AuthAmtSavedGoodToPayDollars>sample string 34</AuthAmtSavedGoodToPayDollars>
  <AuthAmtSavedPaidDollars>sample string 35</AuthAmtSavedPaidDollars>
  <AuthApprovedAmount>sample string 25</AuthApprovedAmount>
  <AuthExceptionDeniedAmount>sample string 27</AuthExceptionDeniedAmount>
  <AuthGoodToPayDollars>sample string 29</AuthGoodToPayDollars>
  <AuthGoodToPayUnits>sample string 28</AuthGoodToPayUnits>
  <AuthPaidDollars>sample string 31</AuthPaidDollars>
  <AuthPaidUnits>sample string 30</AuthPaidUnits>
  <AuthQty>sample string 32</AuthQty>
  <AuthRecoupAmount>sample string 26</AuthRecoupAmount>
  <AuthSweepAmount>sample string 36</AuthSweepAmount>
  <AuthTargetAmount>sample string 33</AuthTargetAmount>
  <BudgetAuthLineCount>sample string 40</BudgetAuthLineCount>
  <BudgetLabel>sample string 22</BudgetLabel>
  <Comment>sample string 18</Comment>
  <ConsumerBudgetAmount>sample string 4</ConsumerBudgetAmount>
  <ConsumerBudgetAplliedToID>sample string 9</ConsumerBudgetAplliedToID>
  <ConsumerBudgetEndDate>sample string 3</ConsumerBudgetEndDate>
  <ConsumerBudgetID>sample string 7</ConsumerBudgetID>
  <ConsumerBudgetLineNo>sample string 14</ConsumerBudgetLineNo>
  <ConsumerBudgetNo>sample string 1</ConsumerBudgetNo>
  <ConsumerBudgetStartDate>sample string 2</ConsumerBudgetStartDate>
  <ConsumerBudgetStatus>sample string 11</ConsumerBudgetStatus>
  <ConsumerBudgetType>sample string 8</ConsumerBudgetType>
  <ConsumerPANo>sample string 6</ConsumerPANo>
  <ConsumerProgramCode>sample string 5</ConsumerProgramCode>
  <CreatedBy>sample string 12</CreatedBy>
  <CreatedDateAndTime>sample string 13</CreatedDateAndTime>
  <DimCode1>sample string 41</DimCode1>
  <DimCode2>sample string 42</DimCode2>
  <DisAllowInvoice>sample string 21</DisAllowInvoice>
  <DisAllowTimesheet>sample string 20</DisAllowTimesheet>
  <InitialBudgetAmount>sample string 17</InitialBudgetAmount>
  <LineAction>sample string 23</LineAction>
  <ModifiedBy>sample string 15</ModifiedBy>
  <ModifiedDateAndTime>sample string 16</ModifiedDateAndTime>
  <ServiceGroupCode>sample string 19</ServiceGroupCode>
  <SweepAmount>sample string 24</SweepAmount>
  <SweepToBudgetLable1Amount>sample string 37</SweepToBudgetLable1Amount>
  <SweepToBudgetLable2Amount>sample string 38</SweepToBudgetLable2Amount>
  <SweepToBudgetLable3Amount>sample string 39</SweepToBudgetLable3Amount>
  <WaiverType>sample string 10</WaiverType>
</ConsumerBudget>