ISBudgetSummaryItem.Residual

Description

A residual amount for the service from the accepted budget request.

Syntax

object.Residual

Part	Attribute	Type	Description
`object`	Required	ISBudgetSummaryItem	The `object` always implements the ISBudgetSummaryItem interface

Restriction: This property is readonly.

Return Value

Decimal

Example

Display some information about the budget summary items related to the selected case, including the services and their dollar amount.

Dim aResult
Dim aPatientID
Dim aCaseID
Dim aCase
Dim aPhase
Dim aBudgetSummaryItems, aBudgetSummaryItem
Dim aService
Dim i
Dim aMessage
  
aResult = Profile.Lookup_PatientCaseSearch(aPatientID, aCaseID, "Case Search", True)

Set aCase = Profile.OpenCase(aCaseID)
set aPhase = Profile.LoadShortCodeByCodeType("INITIAL", 127)  'sscBudgetPhase 
  
if aPhase is nothing then 
  Profile.MsgBox("No short code with the specified code")
  exit sub
end if
   
set aBudgetSummaryItems = aCase.GetBudgetSummaryItems(aPhase.ID)
aMessage = aCase.CaseTitle & " was opened on " & aCase.OpenedOn & vbNewLine &_ 
  "Budget Summary Items: "
for i = 0 to aBudgetSummaryItems.Count -1
  set aBudgetSummaryItem = aBudgetSummaryItems.Item(i)
  if aBudgetSummaryItem.ServiceID <> 0 then
    aService = Profile.LoadService(aBudgetSummaryItem.ServiceCode).Description
  else
    aService = "No selected service" 
  end if 
  aMessage = aMessage & vbNewLine & (i + 1) & ") Budget Summary Item Info:" &_ 
    vbNewLine & "         Service: " & aService & vbNewLine &_
    "         Budget: " & aBudgetSummaryItem.Budget & vbNewLine &_ 
    "         Invoiced: " & aBudgetSummaryItem.Invoiced & vbNewLine &_ 
    "         Pending: " & aBudgetSummaryItem.Pending & vbNewLine &_ 
    "         Residual: " & aBudgetSummaryItem.Residual & vbNewLine  
next         

Profile.MsgBox(aMessage)

Note:

In Profile Client v8 on User Interface Residual can be found in Organisation > Work Centre > Work > Cases > Edit Case > Administrative > Financial > Budget tab > Summary > Residual.

Version information

Added in v7.8.0