Totals of money out, money in and net, optionally grouped
Computed by search aggregations over the transactions the token can see. Only settled transactions count unless filter[authorization_status_in] says otherwise. Filters are exact: merchant_id_eq, merchant_id_in, cardholder_id_eq, cardholder_id_in, card_id_eq, card_id_in, property_id_eq, property_id_in, property_group_id_eq, property_group_id_in, category_id_eq, category_id_in, gl_code_id_eq, gl_code_id_in, status_eq, status_in, completion_status_eq, completion_status_in, approval_status_eq, approval_status_in, authorization_status_eq, authorization_status_in, direction_eq, direction_in, integration_key_eq, integration_key_in, provider_eq, provider_in, flagged_eq, flagged_in, transaction_datetime_gteq, transaction_datetime_lteq, merchant_name_cont, archived. Bare dates cover the whole day in the user's time zone. Grouping by a split-level dimension (property, property_group, category, gl_code) counts a split transaction in full in each of its groups, so those group totals can exceed the overall total.
Request
- Base URL: https://api.topkey.io
- URL: https://api.topkey.io/v1/transactions/totals
- Auth: HTTP bearer
Query parameters
Groups to return, biggest spend first (terms groupings; default 10, max 50).
IANA or Rails time zone used for bare date bounds. Defaults to the user's zone, then the account's zone.
Response
The totals.
Changes
No recorded changes to this operation across all 1 revision of this API.