API Reference

Spending summary by period

get
https://api.cardda.com/v1/companies//spending_summary

Returns the company's spending aggregated by time period for a given product.
Granularity is day when start_month equals end_month, otherwise
month. The product query param selects the source: cards, transfers
or pay. An unrecognized product yields an empty array.

Amounts are integers in the record's currency (currency codes are returned
upper-cased).

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

The id of the resource. This is a UUID for most resources, but for user endpoints it is the user's Firebase UID (an opaque string), so no uuid format is asserted here.

Query Params
string
enum
required

Product whose spending is summarized.

Allowed:
string
required

Start month, formatted MM-YYYY.

string
required

End month, formatted MM-YYYY.

Headers
uuid
required

UUID of the company on whose behalf the request is made. Required for every Organization endpoint.
See The company-id header for details on how to obtain
a value for this header and the error responses to expect when it is missing or invalid.

Responses

401

Unauthorized

404

Company not found

Updated 4 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 4 days ago

Did this page help you?