v2

latestSwagger 2.02026-08-04108164321.0 KB
Expense

Retrieves a paginated list of expense entries with rich filtering by date range, user, project, category, chargeable/invoiced status, approval status, and merchant.

get/api/Expense

Query parameters

UpdatedAfterstring date-time

Only return expenses updated after this date-time. Format: MM/dd/yyyy hh:mm:ss tt

ExpenseDateFromstring date-time

Filter expenses with an ExpenseDate on or after this date. Format: MM/dd/yyyy hh:mm:ss tt

ExpenseDateTostring date-time

Filter expenses with an ExpenseDate on or before this date. Format: MM/dd/yyyy hh:mm:ss tt

UserEmailstring

Filter expenses by the email address of the expense user.

UserIDinteger

Filter expenses by the UserID of the expense user.

CategoryNamestring

Filter expenses by expense category name (exact match).

CustomerIDinteger

Filter expenses by Customer/Company ID.

ProjectIDinteger

Filter expenses by Project ID.

isChargeableboolean

Filter by chargeable (billable) status: true for chargeable, false for non-chargeable.

isInvoicedboolean

Filter by invoiced status: true for invoiced expenses, false for uninvoiced.

ExpenseReimbursementIDFKinteger

Filter expenses by a specific reimbursement batch ID.

ExpensePaymentMethodIDFKinteger

Filter expenses by payment method ID.

ExpenseApprovalStatusCodestring

Filter by approval status. Values: Draft, Rejected, Approved, AutoApproved, Pending, Verified.

Searchstring

Search expenses by matching against Merchant name and Expense Category Name.

pageSizeinteger

Number of items per page (max 1000)

pageNumberinteger

Page to display. Starts from 1.

Sortstring

Sort by: DateUpdated, DateCreated, ExpenseDate (append ' desc' for descending).

Response

Returns a paginated list of expense entries with full details.

TotalCountinteger

Total number of expenses matching the filter criteria.

PageNumberinteger

The current page number (1-based).

PageSizeinteger

The number of results per page.