We reserve the right to log and verify your API calls and to contact you if we detect abuse on your part. For example:
- the requests takes too long to return
- the requests return too much data at a time
- The requests are too frequent
We strongly suggest using the date filter parameters to return only the data that is relevant.
https://api.aceproject.com/?fct=getexpensereport&guid=2dacb595-3d5b-4838-bcd3-62425c2ff787&expenseid=NULL&projectid=NULL&filtermyexpenses=True&filterexpensecreatoruserid=NULL&filterexpensecreatorusergroupid=NULL&filterexpensetypeid=NULL&filterexpenselevel=0&filterexpensestatus=NULL&filterdatefrom=NULL&filterdateto=NULL&displaycomments=True&filterprojecttypeid=NULL&filterclientid=NULL&filtertaskid=NULL&filtertaskgroupid=NULL&filtertasktypeid=NULL&sortorder=NULL&asynccall=False&asynccallid=NULL&exportdomainevaleur=NULL&exporttype=NULL&exportdelimiter=NULL&exportdecimalsymbol=NULL&exportlcid=0&exportonscreencolumnsonly=True&exportview=0&exportviewother=NULL&exportfieldstodisplay=NULL&exportremovehtmlonly=True&exportenablefilterxls=False&format=DS
Guid |
String |
False |
|
|
|
|
|
True |
Unique identifier for the authenticated user. The GUID has an expiry date and time which is managed automatically by the API. |
ExpenseId |
Integer |
True |
|
|
NULL |
|
|
False |
Auto-generated unique expense identifier. |
ProjectId |
String |
True |
|
|
NULL |
|
|
False |
Auto-generated unique identifier of a project. |
FilterMyExpenses |
Boolean |
False |
|
True or False |
True |
|
|
True |
Indicates whether to filter only on calling user's expenses. |
FilterExpenseCreatorUserId |
String |
True |
|
|
NULL |
|
|
False |
Unique identifier of a user to filter on expense creator. |
FilterExpenseCreatorUserGroupId |
String |
True |
|
|
NULL |
|
|
False |
Unique identifier of a user group to filter user's created expenses. |
FilterExpenseTypeId |
String |
True |
|
|
NULL |
|
|
False |
Unique identifier of a expense type to filter expenses on. |
FilterExpenseLevel |
Integer |
False |
|
0: All 1: Project Level Only 2: Task Level Only |
0 |
|
|
False |
Indicates whether to filter on a specific expense level. |
FilterExpenseStatus |
String |
True |
|
0: In Progress 1: Submitted 2: Approved 3: Rejected |
NULL |
|
|
False |
Indicates whether to filter on a specific expense status. |
FilterDateFrom |
Date |
True |
|
|
NULL |
|
|
False |
Filter list from specified date. |
FilterDateTo |
Date |
True |
|
|
NULL |
|
|
False |
Filter list to specified date. |
DisplayComments |
Boolean |
False |
|
True or False |
True |
|
|
False |
Any user-defined comment related to the expense entry. |
FilterProjectTypeId |
String |
True |
|
|
NULL |
|
|
False |
Unique identifier of a project type to filter on. |
FilterClientId |
String |
True |
|
|
NULL |
|
|
False |
Unique identifier of a project's associated client to filter on. |
FilterTaskId |
String |
True |
|
|
NULL |
|
|
False |
Unique identifier of a task to filter on. |
FilterTaskGroupId |
String |
True |
|
|
NULL |
|
|
False |
Unique identifier of a task group to filter on. |
FilterTaskTypeId |
String |
True |
|
|
NULL |
|
|
False |
Unique identifier of a task type to filter on. |
SortOrder |
String |
True |
|
|
NULL |
|
|
False |
Comma separated fields used for ordering a list. |
Asynccall |
Boolean |
False |
|
True or False |
False |
|
|
True |
|
Asynccallid |
Integer |
True |
|
|
NULL |
|
|
True |
|
ExportDomaineValeur |
String |
True |
|
|
NULL |
|
|
True |
|
ExportType |
String |
True |
|
|
NULL |
|
|
True |
|
ExportDelimiter |
String |
True |
|
|
NULL |
|
|
True |
|
ExportDecimalSymbol |
String |
True |
|
|
NULL |
|
|
True |
|
ExportLCID |
Integer |
True |
|
|
0 |
|
|
True |
|
ExportOnScreenColumnsOnly |
Boolean |
True |
|
True or False |
True |
|
|
True |
|
ExportView |
Integer |
True |
|
|
0 |
|
|
True |
|
ExportViewOther |
Integer |
True |
|
|
NULL |
|
|
True |
|
ExportFieldsToDisplay |
String |
True |
|
|
NULL |
|
|
True |
|
ExportRemoveHTMLOnly |
Boolean |
True |
|
True or False |
True |
|
|
True |
|
ExportEnableFilterXLS |
Boolean |
True |
|
True or False |
False |
|
|
True |
|
Format |
String |
False |
|
RS: RecordSet DS: DataSet JSON: JSON |
DS |
|
|
True |
Return Format |
Public Class Sample
Public Sub CodeSample_getexpensereport()
Dim strXML As String = String.Empty
Dim dsOutput As DataSet = Nothing
Dim guid As String = String.Empty
Dim sb As New System.Text.StringBuilder
Try
sb = New System.Text.StringBuilder
sb.Append("fct=getexpensereport")
sb.Append(String.Format("&guid={0}", "497949a0-1871-495e-8a9d-e0e5e5b5a903"))
sb.Append(String.Format("&expenseid={0}", "NULL"))
sb.Append(String.Format("&projectid={0}", "NULL"))
sb.Append(String.Format("&filtermyexpenses={0}", True))
sb.Append(String.Format("&filterexpensecreatoruserid={0}", "NULL"))
sb.Append(String.Format("&filterexpensecreatorusergroupid={0}", "NULL"))
sb.Append(String.Format("&filterexpensetypeid={0}", "NULL"))
sb.Append(String.Format("&filterexpenselevel={0}", 0))
sb.Append(String.Format("&filterexpensestatus={0}", "NULL"))
sb.Append(String.Format("&filterdatefrom={0}", "NULL"))
sb.Append(String.Format("&filterdateto={0}", "NULL"))
sb.Append(String.Format("&displaycomments={0}", True))
sb.Append(String.Format("&filterprojecttypeid={0}", "NULL"))
sb.Append(String.Format("&filterclientid={0}", "NULL"))
sb.Append(String.Format("&filtertaskid={0}", "NULL"))
sb.Append(String.Format("&filtertaskgroupid={0}", "NULL"))
sb.Append(String.Format("&filtertasktypeid={0}", "NULL"))
sb.Append(String.Format("&sortorder={0}", "NULL"))
sb.Append(String.Format("&asynccall={0}", False))
sb.Append(String.Format("&asynccallid={0}", "NULL"))
sb.Append(String.Format("&exportdomainevaleur={0}", "NULL"))
sb.Append(String.Format("&exporttype={0}", "NULL"))
sb.Append(String.Format("&exportdelimiter={0}", "NULL"))
sb.Append(String.Format("&exportdecimalsymbol={0}", "NULL"))
sb.Append(String.Format("&exportlcid={0}", 0))
sb.Append(String.Format("&exportonscreencolumnsonly={0}", True))
sb.Append(String.Format("&exportview={0}", 0))
sb.Append(String.Format("&exportviewother={0}", "NULL"))
sb.Append(String.Format("&exportfieldstodisplay={0}", "NULL"))
sb.Append(String.Format("&exportremovehtmlonly={0}", True))
sb.Append(String.Format("&exportenablefilterxls={0}", False))
sb.Append(String.Format("&format={0}", "DS"))
strXML = CallHttp("https://api.aceproject.com/", sb.ToString)
dsOutput = Deserialize(Of DataSet)(strXML)
If dsOutput IsNot Nothing AndAlso dsOutput.Tables.Count > 0 Then
If dsOutput.Tables.Contains("dtAPIErrors") Then
Throw New Exception(String.Format("{0}: {1}", _
dsOutput.Tables(0).Rows(0).Item("ErrorNumber").ToString, _
dsOutput.Tables(0).Rows(0).Item("ErrorDescription").ToString))
End If
End If
Catch ex As Exception
Throw
Finally
If sb IsNot Nothing Then sb = Nothing
If dsOutput IsNot Nothing Then
dsOutput.Dispose()
dsOutput = Nothing
End If
End Try
End Sub
Private Shared Function CallHttp( ByVal url As String, _
ByVal params As String) As String
Dim loHttp As System.Net.HttpWebRequest
loHttp = CType(System.Net.WebRequest.Create(url), System.Net.HttpWebRequest)
loHttp.Method = "POST"
Dim requestWriter As System.IO.StreamWriter = New System.IO.StreamWriter(loHttp.GetRequestStream())
If Not String.IsNullOrEmpty(params) Then
requestWriter.Write(params)
End If
requestWriter.Close()
loHttp.ContentType = "application/x-www-form-urlencoded"
loHttp.Headers.Set("Pragma", "no-cache")
loHttp.AllowAutoRedirect = True
loHttp.KeepAlive = True
loHttp.Timeout = 30 * 1000
Dim loWebResponse As System.Net.HttpWebResponse = CType(loHttp.GetResponse(), System.Net.HttpWebResponse)
Dim enc As Encoding = System.Text.Encoding.UTF8
Dim loResponseStream As System.IO.StreamReader = New System.IO.StreamReader(loWebResponse.GetResponseStream(), enc)
Dim lcHtml As String = loResponseStream.ReadToEnd()
loWebResponse.Close()
loResponseStream.Close()
Return lcHtml
End Function
Private Shared Function Deserialize(Of T)( ByVal strXML As String) As T
Dim objet As T = Nothing
Dim objType As Type = GetType(T)
Try
If Not String.IsNullOrEmpty(strXML) Then
Dim objSerializer As New System.Xml.Serialization.XmlSerializer(objType)
Dim objText As New System.Text.StringBuilder()
Dim objXmlReader As New System.IO.StringReader(strXML)
objet = DirectCast(objSerializer.Deserialize(objXmlReader), T)
objXmlReader.Close()
End If
Return objet
Catch ex As Exception
Throw
Finally
If objet IsNot Nothing Then objet = Nothing
End Try
End Function
End Class