API Reference
  1. Ewity Apps API
  2. Expenses

Get Expense Dashboard Summary

get
https://api.ewitypos.com/apps-v1/expenses/summary

Returns the aggregate figures behind the expense dashboard: totals and counts for an active period, a comparison against a previous period (delta is the percentage change, null when the previous period has no expenses), a per-month breakdown segmented by category, and the active period's category breakdown.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string
required

Active period start (Y-m-d).

string
required

Active period end (Y-m-d).

string
required

Comparison period start (Y-m-d).

string
required

Comparison period end (Y-m-d).

string
required

Start of the monthly breakdown range (Y-m-d; snapped to the start of its month).

string
required

End of the monthly breakdown range (Y-m-d).

string

Restrict all figures to these expense category ids, comma-separated.

string

Restrict all figures to expenses matching this free-text search (description, vendor, bill number).

Headers
string
required

The merchant install this request acts on (install.store_id from the app.installed webhook).

Response

Updated 13 days ago

Did this page help you?
Language
Credentials
Bearer
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 13 days ago

Did this page help you?