v1

Swagger 2.02026-07-13107162315.5 KB
ExpenseSummary

Retrieves aggregated expense statistics for a date range, with optional grouping by up to three dimensions (e.g. Category, Project, User, Month). Requires ExpenseDateFrom and ExpenseDateTo.

get/api/ExpenseSummary

Query parameters

model.groupBystring[]

(Optional) Combine one, two or three levels of Grouping. Combine these possible grouping values: "Category", "ChargeableStatus", "Merchant", "ApprovalStatus", "ReimbursementStatus", "Customer", "Project", "User", "Task", "Year", "Month", "Day", "Week".

model.expenseDateFromstring date-time

(Required) Filter for expenses with expense dates greater or equal to the specified date. e.g. 2019-01-25.

model.expenseDateTostring date-time

(Required) Filter for expenses with an expense date smaller or equal to the specified date. e.g. 2019-01-25.

model.userIDinteger[]

(Optional) Defaults to the current user. Provide one or more UserIDs of Users whose expenses should be retrieved. If the current user doesn't have impersonation rights, then they will only see their own data.

model.projectIDinteger

(Optional) Filter by Project

Response

Returns aggregated expense totals with optional grouping.

ExpenseDateFromstring date-time

Start date for the summary period.

ExpenseDateTostring date-time

End date for the summary period.

TotalAmountnumber double

Total expense amount for the period.

UserIDinteger[]

Optional user ID(s) the summary is filtered by.

GroupingLevelsstring[]

The grouping dimensions applied to the summary data.