API Call Samples

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.
Select category  

Select function  

Function Details
Name Guid Required Description
GetExpenseReport True Retrieves list of expenses for reporting purposes.

Code Sample (Visual Basic, Dotnet Framework 4.x): 
Public Class Sample
	
	Public Sub CodeSample_getexpensereport()
		Dim params = New NameValueCollection From {
					{"fct", "getexpensereport"},
					{"guid", "###"}
		}

		Dim jsonText = apiCall(params)

		' https://www.newtonsoft.com/json suggested for JSON parsing to DotNet framework 4.x
		Dim jsonObj = Newtonsoft.Json.Linq.JObject.Parse(jsonText)

		Dim success = jsonObj.Item("status").ToString <> "fail"
		Dim jResults = DirectCast(jsonObj.Item("results"), Newtonsoft.Json.Linq.JArray)

		
	End Sub
	    
	Function apiCall(_param As NameValueCollection) As String

		Dim wc As New System.Net.WebClient With {
			.Encoding = System.Text.Encoding.UTF8
		}

		' may be needed on some machines
		Net.ServicePointManager.SecurityProtocol = CType(Net.SecurityProtocolType.Tls12, Net.SecurityProtocolType)

		_param.Item("format") = "iso8601" ' json, with dates formatted as ISO8601 string

		Dim responseBytes = wc.UploadValues("https://api.aceproject.com", "POST", _param)
		Return System.Text.Encoding.UTF8.GetString(responseBytes)

	End Function

End Class

Parameter Details
Name DataType Is Nullable Max length Domain Values Default Value Is Required
(Insert)		 Is Required
(Update)		 Is Required Description
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.
Format String False RS: RecordSet
DS: DataSet
JSON: JSON		 DS True Return Format