Knowledgebase:
GetSettledStatus
Posted by Mohammad Rahhal, Last modified by Rawan Al Hourani on 04 July 2017 03:07 PM

Syntax

 Public Function GetSettledStatus (Optional ClientID As Integer = 0, Optional LastXDays As Integer = -1, Optional FromDate As String = "", Optional ToDate As String = "") As CallingResultsEnum

This function is used to make the API able to get the settled status for the given client number through SettledStatusSymbolAdded event and settled status updates for the given client number through SettledStatusSymbolChanged event . 

Parameters

Parameter Description 
ClientID Client ID that want to get his settled status, value of type integer. 0: for all Account under that dealer
LastXDays To get the settled status for the last certain days. 
-1: for Custome period
 1: for last day
 2: for last two days
 4: for last four days
 7: for last week
14: for last two weeks
30: for last month
60: for last two months
FromDate The starting date of the settled status if  LastXDays = -1 
Date in this format ”DD/MM/YYYY HH:NN:SS”
“” means from Beginning
ToDate The ending date of the settled status if  LastXDays = -1
Date in this format ”DD/MM/YYYY HH:NN:SS”
“” means till now

Return value

Return value of type CallingResultsEnum, if the request sent to server successfully it will return SuccessResult.

Sample

 Private Sub GetSetStatus_Click (ByVal sender As System.Object, ByVal e As System.EventArgs)Handles GetSetStatus.Click

         ‘BOAPI is a predefined variable as CVertexBOAPI10  

         ‘If From Date was "" means from begining

         ‘If To Date was "" means till now

          Dim Result As CallingResultsEnum
          Dim vClient As COClient
          vClient = m_oBOAPI.ClientByIndex(1)
               Result= BOAPI.GetSettledStatus (vClient.clientID,-1,"","")
         Msgbox (Result.ToString)

 End Sub


See Also


VertexFX Backoffice API Index

(0 vote(s))
Helpful
Not helpful

Comments (0)
Post a new comment
 
 
Full Name:
Email:
Comments:
CAPTCHA Verification 
 
Please enter the text you see in the image into the textbox below (we use this to prevent automated submissions).

Help Desk Software by Hybrid Solutions