GET api/{programid}/v2/Budget/GetCurrentBudgetDetails/{consumerNumber}

Retrieves the information about the current budget for a specific consumer

Request Information

URI Parameters

Name	Description	Type	Additional information
programid	PPL Program Id	string	Required
consumerNumber	PPL Consumer No.	string	Required

Body Parameters

None.

Response Information

Resource Description

BudgetDetailQueryModel

Name	Type	Additional information
BudgetId	string	None.
ConsumerNumber	string	None.
StartDate	date	None.
EndDate	date	None.
PeriodBudgetAmount	decimal number	None.
TotalSpendAmount	decimal number	None.
PostedDocuments	Collection of PostedDocumentDetail	None.

Response Formats

application/json, text/json

Sample:

{
  "BudgetId": "sample string 1",
  "ConsumerNumber": "sample string 2",
  "StartDate": "2024-11-16T05:07:56.0426453-05:00",
  "EndDate": "2024-11-16T05:07:56.0426453-05:00",
  "PeriodBudgetAmount": 5.0,
  "TotalSpendAmount": 6.0,
  "PostedDocuments": [
    {
      "EmployeeFirstName": "sample string 1",
      "EmployeeMiddleName": "sample string 2",
      "EmployeeLastName": "sample string 3",
      "ServiceDescription": "sample string 4",
      "TotalHours": 5,
      "TotalMinutes": 6,
      "TotalAmount": 7.0
    },
    {
      "EmployeeFirstName": "sample string 1",
      "EmployeeMiddleName": "sample string 2",
      "EmployeeLastName": "sample string 3",
      "ServiceDescription": "sample string 4",
      "TotalHours": 5,
      "TotalMinutes": 6,
      "TotalAmount": 7.0
    }
  ]
}

application/xml, text/xml

Sample:

<BudgetDetailQueryModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PPL.Services.Models.v2.Budget.QueryModels">
  <BudgetId>sample string 1</BudgetId>
  <ConsumerNumber>sample string 2</ConsumerNumber>
  <EndDate>2024-11-16T05:07:56.0426453-05:00</EndDate>
  <PeriodBudgetAmount>5</PeriodBudgetAmount>
  <PostedDocuments>
    <BudgetDetailQueryModel.PostedDocumentDetail>
      <EmployeeFirstName>sample string 1</EmployeeFirstName>
      <EmployeeLastName>sample string 3</EmployeeLastName>
      <EmployeeMiddleName>sample string 2</EmployeeMiddleName>
      <ServiceDescription>sample string 4</ServiceDescription>
      <TotalAmount>7</TotalAmount>
      <TotalHours>5</TotalHours>
      <TotalMinutes>6</TotalMinutes>
    </BudgetDetailQueryModel.PostedDocumentDetail>
    <BudgetDetailQueryModel.PostedDocumentDetail>
      <EmployeeFirstName>sample string 1</EmployeeFirstName>
      <EmployeeLastName>sample string 3</EmployeeLastName>
      <EmployeeMiddleName>sample string 2</EmployeeMiddleName>
      <ServiceDescription>sample string 4</ServiceDescription>
      <TotalAmount>7</TotalAmount>
      <TotalHours>5</TotalHours>
      <TotalMinutes>6</TotalMinutes>
    </BudgetDetailQueryModel.PostedDocumentDetail>
  </PostedDocuments>
  <StartDate>2024-11-16T05:07:56.0426453-05:00</StartDate>
  <TotalSpendAmount>6</TotalSpendAmount>
</BudgetDetailQueryModel>